Documentação da API

Nossa API RESTful permite que você integre as capacidades de processamento de pagamento do Máximo Pay diretamente em suas aplicações, websites ou serviços. Seja construindo uma plataforma de e-commerce, um serviço de assinatura ou uma solução financeira customizada, nossa API fornece as ferramentas que você precisa.

Esta documentação cobre tudo, desde a autenticação e como fazer sua primeira chamada à API até o manuseio de webhooks e gerenciamento de erros. Buscamos simplicidade e poder, oferecendo funcionalidades robustas com comportamento claro e previsível.

Antes de começar, certifique-se de que possui uma conta no Máximo Pay. Você pode gerenciar suas chaves de API e configurações no seu painel de desenvolvedor.

Todas as requisições à API do Máximo Pay devem ser autenticadas. Usamos chaves de API para permitir o acesso. Você pode obter suas chaves de API no Painel do Desenvolvedor Máximo Pay.

Suas chaves de API carregam muitos privilégios; certifique-se de mantê-las seguras! Não compartilhe suas chaves de API secretas em áreas publicamente acessíveis como GitHub, código do lado do cliente, etc.

A autenticação na API é realizada via HTTP Bearer Authentication. Forneça sua chave de API no cabeçalho `Authorization` da sua requisição.

Todas as requisições à API devem ser feitas sobre HTTPS. Chamadas feitas sobre HTTP simples falharão. Requisições à API sem autenticação também falharão.

Authorization: Bearer SUA_CHAVE_SECRETA_DE_API

Nossa API é organizada em torno de REST. Possui URLs previsíveis orientadas a recursos, aceita corpos de requisição codificados em JSON, retorna respostas codificadas em JSON e usa códigos de resposta HTTP, autenticação e verbos padrão.

A URL base para todas as requisições da API é: `https://api.maximopay.com/v1`

Embora a API do Máximo Pay possa ser integrada usando qualquer cliente HTTP padrão, estamos trabalhando para fornecer SDKs oficiais para linguagens de programação populares (ex: Node.js, PHP, Python, Ruby, Java) para simplificar ainda mais a integração. Estes SDKs cuidarão da autenticação, formação de requisições e parse de respostas, permitindo que você foque na lógica da sua aplicação.

Fique atento aos anúncios em nosso portal do desenvolvedor! Enquanto isso, certifique-se de que seu cliente HTTP esteja configurado para lidar com requisições e respostas JSON e para incluir o cabeçalho `Authorization: Bearer SUA_CHAVE_SECRETA_DE_API` necessário para autenticação.

Nossa API é versionada para garantir a compatibilidade retroativa à medida que introduzimos novas funcionalidades ou fazemos alterações não-quebráveis. A versão da API está incluída no caminho da URL (ex: `/v1/pagamentos`).

Recomendamos especificar a versão da API em suas requisições para garantir que sua integração permaneça estável. Quando lançarmos novas versões da API com alterações quebráveis, forneceremos documentação clara, guias de migração e um cronograma de descontinuação para versões mais antigas. Alterações não-quebráveis e adições podem ser adicionadas à versão atual sem um incremento de versão.

Se você tiver alguma dúvida, encontrar problemas, precisar de assistência com sua integração ou tiver feedback, nossa equipe de suporte está aqui para ajudar. Oferecemos diversos canais de suporte.

Visite nosso Portal do Desenvolvedor para FAQs e fóruns da comunidade. Para assistência direta, contate-nos via email em [email protected] ou através da seção de suporte em seu Painel Máximo Pay.