Como usar a API na prática

1. Exemplo: Registrar um usuário novo

https://github.com/voxy/voxy_partner_api_examples/blob/master/python/client.py#L51

 

2. Exemplo: Atualizar as informações do perfil do usuário

https://github.com/voxy/voxy_partner_api_examples/blob/master/python/client.py#L63

 

3. Exemplo: Visualizar as informações do perfil do usuário

https://github.com/voxy/voxy_partner_api_examples/blob/master/python/client.py#L154

 

4. Exemplo: Visualizar um grupo de usuários 

https://github.com/voxy/voxy_partner_api_examples/blob/master/python/client.py#L161

 

5. Exemplo: Visualizar dados de progresso na unidade e desempenho para um determinado grupo de usuários

https://github.com/voxy/voxy_partner_api_examples/blob/master/python/client.py#L196

 

6. Exemplo: Exibir todos os usuários da sua organização

https://github.com/voxy/voxy_partner_api_examples/blob/master/python/client.py#L189

 

7. Exemplo: SSO - visualizar uma URL com auth_token que faz o login do usuário automaticamente na Voxy

https://github.com/voxy/voxy_partner_api_examples/blob/master/python/client.py#L70

 

8. Problemas comuns

 

  • 401 - Unauthorized. Não foi possível verificar a identidade do solicitante

Esse erro significa que sua solicitação NÃO tinha um cabeçalho de autorização válido e, portanto, não foi possível verificar a identidade do solicitante e a solicitação foi negada. Normalmente, isso acontece devido a uma REQUEST_SIGNATURE gerada incorretamente.

Para gerar a assinatura corretamente, o código deve executar as seguintes etapas:

  1. Obter os parâmetros que foram incluídos na solicitação e organizá-los em ordem alfabética por nome.
  2. Utilizar codificação URL nos parâmetros ordenados alfabeticamente.
  3. Criar uma string de texto que seja uma concatenação da assinatura de API e dos parâmetros codificados da URL da etapa 2 (por exemplo, {{API_SECRET}}+{{URL_ENCODED_PARAMETERS}}.
  4. Criptografar a string usando o algoritmo de hash SHA-256.

O resultado é uma assinatura com criptografia de 256 bits mais ou menos assim: 24412158fe201e7d4d0a22f16b302c3252428ad129d1398eb5d2248d73223a67

Essa assinatura é usada no cabeçalho de autorização incluído na sua solicitação para a Voxy Partner API. O cabeçalho de autorização deve ter esta aparência:

 

{
  "Authorization": "Voxy xPLo0vQ3opfMt9aV:24412158fe201e7d4d0a22f16b302c3252428ad129d1398eb5d2248d73223a67"
}

 

Se você estiver usando parâmetros com caracteres especiais, use a função urlencode não só nos parâmetros, mas também no processo de criação da assinatura. Caso contrário, eles não serão correspondentes e vão gerar assinaturas diferentes, fazendo com que a sua solicitação seja negada.

  

  • 400 - Bad request

 Esse tipo de erro pode aparecer se você incluir parâmetros formatados incorretamente. Por exemplo, a maioria dos parâmetros de datas na Voxy Partner API exige o formato AAAA-MM-DD.  Se enviar a data em algum outro formato, você receberá um erro 400 - Bad request na resposta da API.

Para garantir que sua solicitação tenha todos os parâmetros corretos, consulte a documentação sobre a Voxy Partner API em http://partner-api-docs.voxy.com/docs/.

 

  • 409 - Conflict. O usuário já pertence a outra organização

 Ao tentar registrar um novo usuário/aluno, você pode receber esse erro. Isso significa que o e-mail usado para esse usuário já está vinculado a outra conta da Voxy. Provavelmente esse usuário tem uma conta em outra organização. 

Para resolver esse problema, use outro e-mail. Se o usuário não tiver ou não quiser usar outro e-mail, fale com o CMS e explique a situação.

 

  • 403 - Forbidden - Não é possível acessar esse ponto periférico porque o usuário expirou

Se um usuário estiver expirado, você não poderá solicitar uma URL de início único de sessão e receberá um erro 403 - Forbidden na resposta da API. 

Os usuários expiram quando expiration_date é uma data anterior ao dia atual. Por exemplo, se hoje for 2018-01-05, um usuário estará expirado se a expiration_date for 2018-01-04 ou anterior.  

Para alterar a data de expiração do usuário, você pode fazer uma solicitação PUT para https://partner-api.voxy.com/partners/users/{external_user_id} incluindo um parâmetro expiration_date com um valor de data futuro.

Esse artigo foi útil?
Usuários que acharam isso útil: 0 de 0
Tem mais dúvidas? Submeter um pedido

Comentários

0 comentário

Por favor, entrar para comentar.