OAuth sem dor com PHP – PHP OAuth API – Parte 02

O artigo explica que a classe PHP OAuth API foi feita para acelerar a integração com OAuth sem exigir conhecimento profundo do protocolo. Ela abstrai diferenças entre OAuth 1.0a e 2.0, lida com variações de provedores e apresenta o fluxo básico para obter um token de acesso e chamar uma API.

Fichamento

#

• A classe foi construída para permitir uso rápido de OAuth sem que o desenvolvedor precise dominar o protocolo.
• Ela abstrai as diferenças entre OAuth 1.0a e OAuth 2.0 para evitar código separado para cada versão.
• Também procura esconder diferenças de configuração e implementação entre provedores.
• A função principal da classe é obter um token de acesso e depois chamar a API do provedor com esse token.
• O texto apresenta a abordagem de mapping de caso de uso, em que cada caso de uso é implementado como classe.
• Nessa abordagem, a classe de caso de uso tem quatro funções públicas: Initialize, Process, Finalize e Output.
• Initialize verifica pré-condições obrigatórias e retorna falso quando alguma delas falha.
• Process concentra o trabalho principal e deve ser chamada depois de Initialize.
• Finalize limpa recursos e verifica pós-condições, e não deve ser chamada se Initialize falhar.
• Output é o ponto em que a saída do caso de uso é emitida e pode retornar uma string quando necessário.
• As variáveis básicas da classe incluem $error para mensagens de falha e $exit para indicar que o script deve parar antes de Output.
• Para iniciar a autorização, é preciso definir $server com o tipo de provedor e configurar client_id, client_secret, scope e redirect_uri.
• O fluxo mostrado chama Initialize, depois Process e por fim Finalize.
• Se a autorização der certo, o token de acesso fica em $access_token.
• Em OAuth 1.0a, o segredo adicional fica em $access_token_secret.
• Se houver erro na autorização, a mensagem aparece em $authorization_error e pode ser copiada para $error.
• O script deve verificar $exit e encerrar quando a classe indicar saída imediata.
• Depois de obter o token, a função CallAPI pode ser usada com o token de acesso e, quando necessário, com o segredo do token.
• CallAPI recebe a URL da API, o método HTTP, os parâmetros e opções, e pode decodificar respostas codificadas em URL ou JSON.
• Se a chamada da API falhar por problema de parâmetros ou de token, a mensagem fica em $access_token_error.
• A conclusão afirma que a classe reduz a quantidade de código necessária para autorizar acesso a APIs e depende apenas de uma classe HTTP para enviar as requisições.