Fluxo de autorização do usuário
Toda vez que uma integração instalada é aberta, a SendPulse envia um código para a URL de Login que você especificou ao criar sua aplicação. Para obter chaves para chamadas de API via sua aplicação, você precisa enviar uma solicitação com esse código e as chaves da aplicação.
Um fluxo de autorização do usuário da aplicação começa em dois casos:
- Quando um usuário instala sua aplicação pela primeira vez e concede permissões;
- Quando um usuário abre a página da sua aplicação em sua conta SendPulse clicando em Visualizar ao lado da sua aplicação.
Veja como é o fluxo de autorização do usuário:
Exemplo de uma solicitação POST da SendPulse para enviar um código:
| https://YOUR_INSTALL_URL/?code={code}lang=en |
Parâmetros da URL de solicitação:
сode |
string | O código é gerado quando o usuário abre sua aplicação.
Este código é válido por 1 minuto. |
lang |
string | O idioma da conta SendPulse do usuário. |
Para obter as chaves do usuário da aplicação, envie uma solicitação POST para:
| https://api.sendpulse.com/market-service/oauth/authorize |
Parâmetros da solicitação:
app_id |
string | O ID da aplicação que aparece em sua conta de desenvolvedor após adicionar sua aplicação.* |
secret |
string | A chave secreta que aparece em sua conta de desenvolvedor após adicionar sua aplicação.* |
code |
string | O código que a SendPulse envia para sua URL de Login.
O código é válido por 1 minuto. |
*Para encontrar suas chaves da aplicação, vá ao Diretório de Aplicações > Criados. Ao lado de sua aplicação, clique nos três pontos e selecione Editar. Copie suas chaves nos campos ID da aplicação e Chave secreta e salve-as em seu sistema.
Exemplo de solicitação:
{
"app_id": "9b0f2f98-d75f-4562-887e-2b79bc8a1eee",
"secret": "0d028163-9c84-40e4-8508-f4927badf735",
"code": "21efd6b100b2602cb2d75cb06c2bf37f"
}
Se sua solicitação for bem-sucedida, a integração receberá suas chaves de usuário da aplicação (client_id e client_secret), com as quais você poderá obter o token de usuário da sua aplicação.
Exemplo de resposta se a solicitação for bem-sucedida:
{
"result": true,
"data": {
"id": "9b0f56dd-4f4d-4792-ae20-23f99659b69e",
"user_id": 7043663,
"app_id": "9b0fdd98-d75f-4562-887e-2b79bc8a1eee",
"client_id": "b2bfd8a8441294fa0171c195ada8cf56",
"client_secret": "f7064fb0bbecd392d7b3ea2e2bd77758",
"created_at": "2024-01-10T15:50:20.000000Z",
"updated_at": "2024-01-10T15:50:20.000000Z"
}
}
Parâmetros da resposta
id |
uuid | ID da conta SendPulse do usuário.
Você pode usar este ID para adicionar um usuário à sua aplicação privada. |
client_id |
string | Chave do usuário da aplicação para acessar a API* |
client_secret |
string | Chave do usuário da aplicação para acessar a API* |
created_at |
datetime | Data e hora em que a primeira conexão foi criada. |
updated_at |
datetime | Data e hora em que a última conexão foi atualizada. |
*Recomendamos salvar os parâmetros client_id e client_secret em seu sistema para que sua aplicação funcione em segundo plano. As chaves do usuário da aplicação permanecem as mesmas quando um usuário usa sua aplicação. Você pode coletar e atualizar outros parâmetros para armazenar dados do usuário, por exemplo, por ID.
Se sua solicitação não for bem-sucedida, você receberá um erro 422 Unprocessable Entity.
Exemplo de resposta se a solicitação não for bem-sucedida:
{
"result": false,
"data": null,
"error": "Сonnect not found!",
"code": 5
}Se você recebeu um erro, verifique os dados que usou e envie a solicitação novamente.
Última Atualização: 29.08.2024
ou