API significa Interface de Programação de Aplicativo. Uma API é um conjunto de funções e procedimentos que ajudam os usuários a acessar os recursos ou dados de um aplicativo, serviço ou sistema operacional diretamente de outro aplicativo. Vamos dar uma olhada em um exemplo simples para entendê-lo melhor.
Quando você está reservando um filme ou passagem aérea, geralmente verá uma opção Adicionar ao Google Agenda no site de reservas. Quando você clica neste botão, o site de reservas se comunica com o servidor do Google diretamente em segundo plano com uma solicitação para criar uma programação de eventos. O servidor do site de reservas processará a resposta e exibirá a mensagem de confirmação na tela. Em outras palavras, você está usando um recurso de um aplicativo sem acessar sua interface.
As APIs do ExplicadorAPI fornecem a opção para os usuários realizarem gerenciamento de usuários, gerenciamento de documentos e outras operações diretamente, sem acessar a interface da web doExplicadorAPI. Fornecemos Interface de Programação de Aplicativo de Transferência de Estado Representacional (API REST) para atender a esse propósito.
POR QUE REST?
A arquitetura da API REST aproveita os protocolos que já existem. Por exemplo, ele usa o protocolo HTTP para o APIS da web, o que significa que fornece grande flexibilidade para os desenvolvedores usarem as bibliotecas existentes enquanto constroem seus aplicativos personalizados. Foi originalmente desenvolvido pelo Dr. Roy Fielding em 2000 e adotado por desenvolvedores em todo o mundo por sua facilidade de uso e simplicidade.
Cada recurso é exposto como um URL, que pode ser obtido acessando o endpoint raiz da API.
QUÃO SEGURAS SÃO SUAS APIS?
As APIs REST da ExplicadorAPI aproveitam o protocolo OAuth 2.0 padrão da indústria para autorização. Eles autorizam os aplicativos a interagir com eles sem realmente fornecer a senha. Em outras palavras, eles fornecem acesso delegado ao serviço e autorizam aplicativos de terceiros a acessar a conta do usuário com segurança.
QUAIS SÃO AS OPERAÇÕES COM SUPORTE?
As APIs da ExplicadorAPI suportam uma lista crescente de operações mencionadas abaixo.
Instalação
Section intro goes here. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque finibus condimentum nisl id vulputate. Praesent aliquet varius eros interdum suscipit. Donec eu purus sed nibh convallis bibendum quis vitae turpis. Duis vestibulum diam lorem, vitae dapibus nibh facilisis a. Fusce in malesuada odio.
Credenciais da API
Para poder criar as suas credenciais, você precisará de estar autenticado com uma conta
com email confirmado (a confirmação é feita quando você se regista nas nossas
plataformas).
A autenticação é feita com base numa das plataformas da Explicador, isso significa que se
você já tem conta, poderá entrar ou iniciar sessão no e2Payments usando a sua conta
de explicador.co.mz.
Você precisa iniciar sessão na sua conta para ter acesso aos recursos de servidor. Depois de iniciar a sessão, você poderá criar as suas credenciais que terão o seguinte formato:
Um token de acesso é uma cadeia de caractéres opaca que identifica um utilizador, aplicativo ou Sistema. Ele pode ser usado pelo aplicativo para enviar requisições a API da e2Payments. Há diversos métodos que podem ser utilizados para obter tokens de acesso, mas nesta documentação, vamos explicar apenas um método principal.
O token inclui informações sobre quando o token expirará e qual aplicativo ou conta de utilizador gerou o token. Devido às verificações de privacidade e segurança, todas as chamadas ou requisições feitas a API de e2Payments precisam incluir um token de acesso.
Se deseja buscar qualquer recurso no servidor, precisará de solicitar um token de acesso para autenticação, todas as requisições que não possuem o token de acesso no Header, são bloqueadas, retornando-se o erro 401.
Armazenamento do Token de acesso
Vivamus efficitur fringilla ullamcorper. Cras condimentum condimentum mauris, vitae facilisis leo. Aliquam sagittis purus nisi, at commodo augue convallis id. Sed interdum turpis quis felis bibendum imperdiet. Mauris pellentesque urna eu leo gravida iaculis. In fringilla odio in felis ultricies porttitor. Donec at purus libero. Vestibulum libero orci, commodo nec arcu sit amet, commodo sollicitudin est. Vestibulum ultricies malesuada tempor.
APIs
Section intro goes here. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque finibus condimentum nisl id vulputate. Praesent aliquet varius eros interdum suscipit. Donec eu purus sed nibh convallis bibendum quis vitae turpis. Duis vestibulum diam lorem, vitae dapibus nibh facilisis a. Fusce in malesuada odio.
Chamadas de API
O token de acesso pode ser passado apenas no cabeçalho e não pode ser passado no parâmetro de solicitação.
O nome do cabeçalho deve ser O Authorizationvalor do cabeçalho deve serZoho-oauthtoken {access_token}
Algumas dicas
ExplicadorAPI usa verbos HTTP apropriados para cada ação.
Método
Descrição
GET
usado para recuperar recursos
STORE
usado para criar recursos e executar ações de recursos
PUT
usado para atualizar recursos
DELETE
usado para deletar recursos
códigos de status na faixa 2xx significam sucesso
Intervalo 4xx significa que houve um erro nas informações fornecidas
aqueles na faixa 5xx indicam erros do lado do servidor.
Código de Status
Descrição
200
OK
400
pedido ruim
401
acesso não autorizado ou token de autenticação inválido
404
URL não encontrado
405
método não permitido ou método que você chamou não é compatível com a API chamada
500
erro interno
Section Item 3.3
Vivamus efficitur fringilla ullamcorper. Cras condimentum condimentum mauris, vitae facilisis leo. Aliquam sagittis purus nisi, at commodo augue convallis id. Sed interdum turpis quis felis bibendum imperdiet. Mauris pellentesque urna eu leo gravida iaculis. In fringilla odio in felis ultricies porttitor. Donec at purus libero. Vestibulum libero orci, commodo nec arcu sit amet, commodo sollicitudin est. Vestibulum ultricies malesuada tempor.
Integrações
Documentação ou explicação sobre como fazer a integração em diferentes projectos,...
FAQs
Section intro goes here. You can list all your FAQs using the format below.
Section Item 9.1 (FAQ Category One)
What's sit amet quam eget lacinia?
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium.
How to ipsum dolor sit amet quam tortor?
Donec sodales sagittis magna. Sed consequat, leo eget bibendum sodales, augue velit cursus nunc, quis gravida magna mi a libero. Fusce vulputate eleifend sapien. Vestibulum purus quam, scelerisque ut, mollis sed, nonummy id, metus. Nullam accumsan lorem in dui.
Can I bibendum sodales?
Fusce vulputate eleifend sapien. Vestibulum purus quam, scelerisque ut, mollis sed, nonummy id, metus. Nullam accumsan lorem in dui.
Where arcu sed urna gravida?
Aenean et sodales nisi, vel efficitur sapien. Quisque molestie diam libero, et elementum diam mollis ac. In dignissim aliquam est eget ullamcorper. Sed id sodales tortor, eu finibus leo. Vivamus dapibus sollicitudin justo vel fermentum. Curabitur nec arcu sed urna gravida lobortis. Donec lectus est, imperdiet eu viverra viverra, ultricies nec urna.
Section Item 9.2 (FAQ Category Two)
What's sit amet quam eget lacinia?
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium.
How to ipsum dolor sit amet quam tortor?
Donec sodales sagittis magna. Sed consequat, leo eget bibendum sodales, augue velit cursus nunc, quis gravida magna mi a libero. Fusce vulputate eleifend sapien. Vestibulum purus quam, scelerisque ut, mollis sed, nonummy id, metus. Nullam accumsan lorem in dui.
Can I bibendum sodales?
Fusce vulputate eleifend sapien. Vestibulum purus quam, scelerisque ut, mollis sed, nonummy id, metus. Nullam accumsan lorem in dui.
Where arcu sed urna gravida?
Aenean et sodales nisi, vel efficitur sapien. Quisque molestie diam libero, et elementum diam mollis ac. In dignissim aliquam est eget ullamcorper. Sed id sodales tortor, eu finibus leo. Vivamus dapibus sollicitudin justo vel fermentum. Curabitur nec arcu sed urna gravida lobortis. Donec lectus est, imperdiet eu viverra viverra, ultricies nec urna.
Section Item 9.3 (FAQ Category Three)
How to dapibus sollicitudin justo vel fermentum?
Donec sodales sagittis magna. Sed consequat, leo eget bibendum sodales, augue velit cursus nunc, quis gravida magna mi a libero. Fusce vulputate eleifend sapien. Vestibulum purus quam, scelerisque ut, mollis sed, nonummy id, metus. Nullam accumsan lorem in dui.
How long bibendum sodales?
Fusce vulputate eleifend sapien. Vestibulum purus quam, scelerisque ut, mollis sed, nonummy id, metus. Nullam accumsan lorem in dui.
Where dapibus sollicitudin?
Aenean et sodales nisi, vel efficitur sapien. Quisque molestie diam libero, et elementum diam mollis ac. In dignissim aliquam est eget ullamcorper. Sed id sodales tortor, eu finibus leo. Vivamus dapibus sollicitudin justo vel fermentum. Curabitur nec arcu sed urna gravida lobortis. Donec lectus est, imperdiet eu viverra viverra, ultricies nec urna.
Comece imediatamente
ExplicadorAPI torna muito fácil colocar seu projeto online, para que você possa começar a promover ou vender seu produto digital para seu público.