---
# System prepended metadata

title: Untitled

---

![](https://i.imgur.com/hUklDYK.png)


A documentação de todos os endpoints do “Backend CPASS” se encontram disponíveis [aqui](https://api.cpasstech.com.br/docs/).
A autenticação será feita por Authorization header. Desta forma as requisições para os endpoints devem conter o seguinte: `Authorization: Token <chave>`. Para fins de teste, o valor de "<chave>'" será "123".

* Todos os endpoints retornarao respostas paginadas.


1. Listar SKUS disponíveis - GET `/fidelities/plans/`
- Quais informacoes sao necessarias para montar o produto no lado Esfera ?

Retorno

```json=
{                                                                                                                                       
  "count": 3,                                                                                                                           
  "next": null,                                                                                                                         
  "previous": null,                                                                                                                     
  "results": [                                                                                                                          
    {
      "id": "083053d0-9820-46b5-bf29-55b104ceb18d",
      "slug": "hbo-max",
      "name": "hbo max",
      "description": "HBO max",
      "image": "products/hbo-max/hbo-max.jpg",
      "interval_type": "months",
      "interval_value": "1",
      "points": 200,
      "provider": "HBO"
    },
    ...
  ]
}
```
2. Visualizar um único SKU para confirmar se o produto ainda existe - GET `/fidelities/plans/<external_id>/`

Retorno

```json=
{
  "id": "083053d0-9820-46b5-bf29-55b104ceb18d",
  "slug": "hbo-max",
  "name": "hbo max",
  "description": "HBO max",
  "image": "products/hbo-max/hbo-max.jpg",
  "interval_type": "months",
  "interval_value": "1",
  "points": 200,
  "provider": "HBO"
}
```

3. Realizar Troca - POST `/fidelities/exchange-voucher/`
- `plan_id`: deve ser igual a chave `id`, da resposta fornecidade pelo endpoint  `/fidelities/plans/` (1);
- `exchange_id`: De acordo com a reunião que tivemos esse valor será fornecido pela Esfera como uma maneira de identificar a troca de maneira única.

```json=
{
    "name": "Usuario",
    "email": "usuario@gmail.com",
    "cpf": "12341",
    "plan_id": "083053d0-9820-46b5-bf29-55b104ceb18d",
    "exchange_id": "ESFERA",
}
```

Retorno

```json=
{
    "voucher": "VQ13KO",
    "signup_url": "https://app.cpasstech.com.br/login"
}
```
4. Esfera
5. Conciliacao - A ser definido (Ja estamos salvando o `id` enviado por voces)
6. Cancelamento - A ser definido
