Listar Planos
Para listar os planos cadastrados na plataforma, você deve fazer uma requisição para a rota abaixo. Inclua os parâmetros necessários para autenticação.
Route (Rota)
| Método | Rota | Descrição |
|---|---|---|
| GET | /webservice/plans/list | Retorna os planos cadastrados na plataforma |
Headers (Cabeçalho)
| Param | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| Accept | String | application/json | Sim |
| secret | String | *Secret Key | Sim |
| token | String | **Webservice Token | Sim |
*Para conseguir a Secret Key:
- Acesse sua plataforma e faça login na sua conta.
- No menu, vá até a seção de Usuários e acesse Webservice.
- Lá você verá a lista de usuários com suas respectivas Secret Key.
**Token gerado pela rota de autenticação.
Exemplos de Código
cURL
curl --location 'https://dev3.nochalks.com/plans/list' \
--header 'Accept: application/json' \
--header 'secret: {{._webservice_secret}}' \
--header 'token: {{._webservice_token}}'
Node.js
const axios = require('axios');
let config = {
method: 'get',
maxBodyLength: Infinity,
url: 'https://dev3.nochalks.com/plans/list',
headers: {
'Accept': 'application/json',
'secret': '{{._webservice_secret}}',
'token': '{{._webservice_token}}',
}
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
PHP
'application/json',
'secret' => '{{._webservice_secret}}',
'token' => '{{._webservice_token}}',
];
$request = new Request('GET', 'https://dev3.nochalks.com/plans/list', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
Resposta
Status: 200
Mensagem: Dados de planos listados com sucesso!
Resposta:
Mensagem: Dados de planos listados com sucesso!
Resposta:
{
"data": [
{
"id": 1,
"type": 3,
"sale_type": "UNIQUE",
"days": null,
"start_date": null,
"end_date": null,
"url": "https://plataforma-nochalks.com/plans/plano",
"category": null,
"translation": {
"name": "Plano",
"description": "< p>A<\/p>",
"language_id": 1
}
},
{
"id": 2,
"type": 4,
"sale_type": "RECURRENT",
"days": null,
"start_date": null,
"end_date": null,
"url": "https://plataforma-nochalks.com/plans/recorrente",
"category": null,
"translation": {
"name": "Recorrente",
"description": "< p>Teste<\/p>",
"language_id": 1
}
}
],
"links": {
"first": "https://plataforma-nochalks.com/webservice/plans/list?page=1",
"last": "https://plataforma-nochalks.com/webservice/plans/list?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "https://plataforma-nochalks.com/webservice/plans/list",
"per_page": 10,
"to": 2,
"total": 2
}
}