Definição
Application Programming Interface: contrato que define como um programa pode pedir dados ou ações a outro, com as operações, os formatos de entrada e saída e as regras de acesso.
Como funciona
Uma API esconde a implementação e expõe só o necessário. Pode ser uma biblioteca no mesmo processo ou um serviço na rede; neste caso, os estilos mais comuns hoje são REST sobre HTTP com JSON, gRPC e GraphQL, além de SOAP em sistemas mais antigos.
Em telefonia, APIs permitem criar ramais, consultar registros de chamadas, originar ligações e receber eventos. O Asterisk tem AMI, AGI e ARI; o Cisco CUCM tem a AXL, baseada em SOAP.
Toda API exposta na rede precisa de autenticação, autorização e limites de uso, e a documentação (por exemplo, numa especificação OpenAPI) faz parte do contrato.
Na prática
Exemplo fictício: GET https://api.example.com/v1/ramais/2001 devolve o estado do ramal em JSON, e POST https://api.example.com/v1/chamadas origina uma chamada.
Erro comum
Mudar a API sem versão. Mudanças de campo quebram as integrações; versione (v1, v2) e avise antes de remover algo.
Termos relacionados
Referências
Para ir além
- Usando Python para acessar a API AXL do CUCM – Parte 1 (artigo)
- Usando a API do ButtonDown para registrar seus assinantes através do Next.JS (artigo)
Veja também o glossário completo, o blog e os cursos da EDCA.