Spedmo REST API

Olhando para usar alguns dos recursos do Spedmo em sua própria aplicação? Então você veio ao lugar certo.

A API REST Spedmo permite que aplicativos e sites externos sejam integrados aos dados e serviços da Spedmo. A API é livre de usar e uma definição completa de serviços fornecidos pode ser encontrada na nossa interface de especificação da API Swagger UI , que também fornece um arnês de teste útil para testes e recursos de solução de problemas da API.

Começando

1. Obter uma chave API (SPEDMO-API-KEY)

Antes de usar a API para o seu aplicativo, uma chave da API deve ser gerada, que fornecerá o mecanismo para identificar suas chamadas para a API a partir de outras aplicações. Para começar, basta iniciar sessão no Spedmo com a sua conta e a sua chave da API pode ser gerada a partir do console de Gerenciamento da API .

Sua chave de API será UUID e é chamada de " SPEDMO-API-KEY " quando usada para transações com o serviço.

2. Teste que a chave é funcional com a API

A interface de especificação da API Spedmo REST Swagger UI permite testes rápidos e fáceis da API sem a necessidade de configurar software personalizado e está disponível para você usar como uma ferramenta de depuração rápida e fácil para possíveis problemas de integração que possam ocorrer com seu aplicativo .

Com sua chave de API, você poderá testar o News.api e verificar se sua chave permite que você receba uma resposta do sistema. Basta digitar sua chave no chicote e pressione o botão " Tente! ". Se o seu teste foi bem sucedido com o conteúdo retornado, você está pronto para integrar recursos em seu aplicativo.

Alternativamente, a API pode ser atingida usando um aplicativo como CURL, como mostrado no exemplo abaixo.

curl -X GET --header 'Aceitar: application / json' --header 'SPEDMO-API-KEY: YOUR-KEY-AQUI ' 'https://www.spedmo.com/api/v1.0/news.api '

Se sua chave não retornar um resultado, verifique se você seguiu as instruções acima corretamente.

3. Obtendo uma chave de usuário para obter dados pessoais (SPEDMO-ACCESS-KEY)

Para as principais características da API REST, será necessária uma chave de usuário para ler dados pessoais, como detalhes de contato do usuário e contribuições dos usuários (vôos, animações etc.). Esta chave é obtida solicitando que um usuário permita o acesso ao seu aplicativo, a chave uma vez obtida é válida indefinidamente, portanto, não há necessidade de re-solicitar constantemente essa chave de um usuário, uma vez que seu aplicativo o tenha recebido, ele deve ser armazenado em algum lugar dentro do seu aplicativo ou serviço.

Para apresentar o usuário com o pedido, basta exibir / enquadrar o seguinte URL dentro da sua aplicação https://www.spedmo.com/apiAuthorise.pg e apresentar sua " SPEDMO-API-KEY " no cabeçalho da solicitação. Se você deseja remover a navegação Spedmo da experiência, basta adicionar ' whitelabel = true ' como um parâmetro de solicitação.

curl -X GET --header 'Aceitar: application / json' --header 'SPEDMO-API-KEY: YOUR-KEY-AQUI ' 'https://www.spedmo.com/apiAuthorise.pg?whitelabel=true'

A resposta retornará como HTML e deve ser apresentada diretamente para usar o usuário, um exemplo de saída esperada é mostrado no diagrama abaixo.

telefone-api

O Spedmo cuidará de processar as entradas dos usuários, sua aplicação deve monitorar o cabeçalho da resposta da página e procurar o " SPEDMO-ACCESS-KEY ". Esta chave em combinação com sua " SPEDMO-API-KEY " permitirá que seu aplicativo use os recursos completos da API do Spedmo REST.

4. Teste que uma chave de usuário seja funcional com a API

Com sua chave de usuário, obtenha informações de membros do usuário usando o Member.api .

curl -X GET --header 'Aceitar: application / json' --header 'SPEDMO-ACCESS-KEY: USER-KEY-AQUI ' --header 'SPEDMO-API-KEY: YOUR-KEY-AQUI ' 'https: / /www.spedmo.com/api/v1.0/member.api '

Para obter documentação sobre todos os outros recursos da API REST, consulte a especificação Swagger UI API.