Pular para o conteúdo principal

Autenticação

Autenticação com API Key​

A Arpoone API utiliza o protocolo HTTP/JSON e suporta autenticação através da utilização de uma API Key que deve ser parametrizada num Bearer token no header Authorization do pedido HTTP. Exemplo:

Authorization: Bearer ZTk1OGMwN2QtOGFmZi00MGY2LWIyY2ItNWFjM2FjNTUyYjg5

Cada utilizador da plataforma Arpoone pode apenas ter uma API Key e a mesma é utilizada pela Arpoone API para identificar o utilizador.

Parametrização de Organization ID​

Em adição à API Key, em várias das operações da Arpoone API é necessário indicar a Organização onde a operação irá actuar, uma vez que um utilizador pode ter acesso a mais do que uma Organização. Nas operações que necessitam da especificação de Organização, esta deve ser identificada através do campo organizationId parametrizado no corpo do pedido HTTP. Excerto de um exemplo:

{
  "organizationId": "e2743dd6-0ac5-4251-8c12-3646f53adcf7",
  ...
}

Obtenção de API Key e Organization ID​

Etapa 1: Configurações​

No canto superior direito clique na Fotografia de Perfil e clique nas configurações

Etapa de configurações

Passo 2: Configurações de utilizador​

No menu lateral aceda a Configurações do utilizador -> Chave API

Etapa de configurações do utilizador

Se você ainda não possui uma chave de API​

Gere uma nova API Key através do botão Gerar nova chave.

Não tem chave de API

Se já possuir uma chave de API​

Copie a API Key para que a possa parametrizar no header Authorization.

Já tem chave de API

Usar a API Key​

Para usar a API, adicione no Header HTTP Authorization das chamadas:

Authorization: Bearer <<Your_APIKey>>

Exemplo utilizando cURL:

curl
--header 'Authorization: Bearer <<Your_APIKey>>
--header 'Content-Type: application/json'
--data-raw '{
  "OrganizationId": "19349aea-796e-4836-a598-26b2daa31deb",
  "Messages": [{
    "To": "to@email.com",
    "From": "sender@email.com",
    "DisplayName": "Sender",
    "Subject": "Subject",
    "ExpirationDateTime": "2022-01-01 12:00:00",
    "TextContent": "Content in simple text",
    "HtmlContent": "Content in <strong>HTML</strong> text"
  }]
}' -X POST https://api.arpoone.com/v1.1/email/send