Skip to content

Latest commit

 

History

History
305 lines (261 loc) · 9.01 KB

customer_subscriptions.markdown

File metadata and controls

305 lines (261 loc) · 9.01 KB
title position en breadcrumb layout
Importações de Assinaturas
7
/en/imports
Importações de Assinaturas
pt

Importações de Assinaturas

Recurso Descrição
POST /api/v1/imports/customer_subscriptions Importar assinaturas
GET /api/v1/imports/customer_subscriptions/:id Informações da importação
GET /api/v1/imports/customer_subscriptions Listar importações

Modelo de Dados

Parâmetro Obrigatório Tipo Tamanho Descrição
id N/A Integer ID da importação
source Sim Arquivo
source_type Não String Tipo do arquivo (possíveis valores)
processed_rows N/A Integer Número de assinaturas processadas
created_rows N/A Integer Número de assinaturas criadas
updated_rows N/A Integer Número de assinaturas alteradas
enqueued_at N/A Time Data/hora de enfileiramento
started_at N/A Time Data/hora do início do processo de importação
finished_at N/A Time Data/hora do término do processo de importação
import_errors N/A Array Erros de importação, caso existam
source_file_name N/A String Nome do arquivo
source_file_size N/A Integer Tamanho em bytes do arquivo
status N/A String Situação do arquivo (possíveis valores)
created_via_api N/A Boolean Enviado pela API
customer_ignore_email Não Boolean Nunca enviar e-mail para este cliente
customer_ignore_sms Não Boolean Nunca enviar SMS para este cliente

Dicionário de Dados

status

| enqueued | Aguardando processamento | aborted | Processamento não realizado devido a erro | done | Processamento concluído

Importar carnê

POST /api/v1/imports/customer_subscriptions

Você pode enviar arquivos no formato CSV 

Arquivo CSV

A extensão do arquivo deve ser .csv

Exemplo: assinaturas.csv

Arquivos de Exemplo

Exemplo de requisição inválida

Requisição: 
curl -i \
-H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \
-H 'Content-Type: multipart/form-data' \
-H 'User-Agent: MyApp ([email protected])' \
-X POST 'https://api-sandbox.kobana.com.br/v1/imports/customer_subscriptions'

<small>Resposta:</small>

HTTP/1.1 422 Unprocessable Entity
Server: Cowboy
Connection: keep-alive
Strict-Transport-Security: max-age=2592000
Content-Type: application/json; charset=utf-8
...

{"errors":{"customer_subscription_import":["não pode assinaturas em branco"]}}

Exemplo de requisição válida

Requisição: 
curl -i \
-H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \
-H 'Content-Type: multipart/form-data' \
-H 'User-Agent: MyApp ([email protected])' \
-F "customer_subscription_import[source][email protected]" \
-X POST 'https://api-sandbox.kobana.com.br/v1/imports/customer_subscriptions'

<small>Resposta:</small>

HTTP/1.1 201 Created
Server: Cowboy
Connection: keep-alive
Strict-Transport-Security: max-age=2592000
Location: https://api-sandbox.kobana.com.br/v1/imports/customer_subscriptions
Content-Type: application/json; charset=utf-8
...

{
  "id":1,
  "processed_rows":10,
  "created_rows":10,
  "updated_rows":0,
  "total_rows":10,
  "failed_to_create_rows":0,
  "failed_to_update_rows":0,
  "enqueued_at":"2018-03-19T15:23:10-03:00",
  "started_at":"2018-03-19T15:23:13-03:00",
  "finished_at":"2018-03-19T15:23:16-03:00",
  "import_errors":[],
  "source_content_type":"text/plain",
  "source_file_name":"assinaturas.csv",
  "source_file_size":10401,
  "created_via_api":true,
  "status":"enqueued"
}

Informações da importação

GET /api/v1/imports/customer_subscriptions/:id

Exemplo

Requisição: 
curl -i \
-H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \
-H 'Content-Type: application/json' \
-H 'User-Agent: MyApp ([email protected])' \
-X GET 'https://api-sandbox.kobana.com.br/v1/imports/customer_subscriptions/1'

<small>Resposta:</small>

HTTP/1.1 200 OK
Server: Cowboy
Connection: keep-alive
Strict-Transport-Security: max-age=2592000
Content-Type: application/json; charset=utf-8
...

{
  "id":1,
  "processed_rows":10,
  "created_rows":10,
  "updated_rows":0,
  "total_rows":10,
  "failed_to_create_rows":0,
  "failed_to_update_rows":0,
  "enqueued_at":"2018-03-19T15:23:10-03:00",
  "started_at":"2018-03-19T15:23:13-03:00",
  "finished_at":"2018-03-19T15:23:16-03:00",
  "import_errors":[],
  "source_content_type":"text/plain",
  "source_file_name":"assinaturas.csv",
  "source_file_size":10401,
  "created_via_api":true,
  "status":"done"
}

Listar importações

GET /api/v1/imports/customer_subscriptions

<tr>
  <td>
    <strong>per_page </strong>
  </td>
  <td>
    Não
  </td>
  <td>
    Number
  </td>
  <td>
    Quantidade de registros por página (Máximo de 50)
  </td>
</tr>
Parâmetro Obrigatório Tipo Descrição
page Não Number Número da Página

Exemplo

Requisição: 
curl -i \
-H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \
-H 'Content-Type: application/json' \
-H 'User-Agent: MyApp ([email protected])' \
-X GET "https://api-sandbox.kobana.com.br/v1/imports/customer_subscriptions?page=1&per_page=50"

<small>Resposta:</small>

HTTP/1.1 200 OK
Server: Cowboy
Connection: keep-alive
Strict-Transport-Security: max-age=2592000
Total: 1
Content-Type: application/json; charset=utf-8
...

[
  {
    "id":1,
    "processed_rows":10,
    "created_rows":10,
    "updated_rows":0,
    "total_rows":10,
    "failed_to_create_rows":0,
    "failed_to_update_rows":0,
    "enqueued_at":"2018-03-19T15:23:10-03:00",
    "started_at":"2018-03-19T15:23:13-03:00",
    "finished_at":"2018-03-19T15:23:16-03:00",
    "import_errors":[],
    "source_content_type":"text/plain",
    "source_file_name":"assinaturas.csv",
    "source_file_size":10401,
    "created_via_api":true,
    "status":"done"
  }
]