Autenticação

O acesso à API de entrega é baseado em autenticação básica HTTP.

Para poder chamar nossa API, você precisa usar suas credenciais de API das configurações da empresa no seu painel https://dash.shippify.co/settings

O domínio para chamar todos os endpoints é https://api.shippify.co

Você receberá um APP ID e um APP SECRET do painel para solicitar nossa API usando autenticação básica (basic auth).

Você não deve chamar a API do Servidor a partir do seu aplicativo cliente para proteger seu API Token. Se o seu API Token for comprometido, você pode perder todos os seus dados.

Se você ainda não tem uma conta, por favor, crie uma preenchendo um formulário em nosso website

Melhores práticas para o uso seguro de chaves de API

Quando você usa chaves de API em suas aplicações, tenha cuidado para mantê-las seguras. Expor publicamente suas credenciais pode resultar em comprometimento da sua conta, o que poderia levar a cobranças inesperadas. Para manter suas chaves de API seguras, siga este guia de melhores práticas:

  • Não incorpore chaves de API diretamente no código: Chaves de API que estão embutidas no código podem ser acidentalmente expostas ao público — por exemplo, se você esquecer de remover as chaves de código que você compartilha. Em vez de incorporar suas chaves de API em suas aplicações, armazene-as em variáveis de ambiente ou em arquivos fora da árvore de fontes da sua aplicação.

  • Não armazene chaves de API em arquivos dentro da árvore de fontes da sua aplicação: Se você armazenar chaves de API em arquivos, mantenha os arquivos fora da árvore de fontes da sua aplicação para ajudar a garantir que suas chaves não acabem no seu sistema de controle de código fonte. Isso é particularmente importante se você usa um sistema público de gerenciamento de código fonte, como o GitHub.

  • Restrinja suas chaves de API para serem usadas apenas pelos endereços IP, URLs de referência e aplicativos móveis que precisam delas: Ao restringir os endereços IP, URLs de referência e aplicativos móveis que podem usar cada chave, você pode reduzir o impacto de uma chave de API comprometida. Você pode especificar os hosts e aplicativos que podem usar cada chave a partir do console, abrindo a página de Credenciais e então criando uma nova chave de API com as configurações que deseja, ou editando as configurações de uma chave de API existente.

  • Delete chaves de API desnecessárias: Para minimizar sua exposição a ataques, delete quaisquer chaves de API que você não precise mais.

  • Revise seu código antes de liberá-lo publicamente: Garanta que seu código não contenha chaves de API ou qualquer outra informação privada antes de tornar seu código publicamente disponível.