{
  "info": {
    "name": "API para desenvolvedores · SMSVEX",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api.smsvex.com/api/v1/integration"
    },
    {
      "key": "apiKey",
      "value": ""
    }
  ],
  "item": [
    {
      "name": "Ver o saldo",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "X-API-Key",
            "value": "{{apiKey}}",
            "type": "text"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/balance",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "balance"
          ]
        },
        "description": "O saldo da conta dona da chave, em centavos."
      }
    },
    {
      "name": "Listar pedidos",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "X-API-Key",
            "value": "{{apiKey}}",
            "type": "text"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/orders?page=&per_page=&desfecho=&de=&ate=&q=",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders"
          ],
          "query": [
            {
              "key": "page",
              "value": "",
              "disabled": true,
              "description": "Página e tamanho (até 100)."
            },
            {
              "key": "per_page",
              "value": "",
              "disabled": true,
              "description": "Página e tamanho (até 100)."
            },
            {
              "key": "desfecho",
              "value": "",
              "disabled": true,
              "description": "aberto, com_codigo, esperando, recebido, expirado, estornado ou cancelado."
            },
            {
              "key": "de",
              "value": "",
              "disabled": true,
              "description": "Início e fim do período, em AAAA-MM-DD, no horário de Brasília."
            },
            {
              "key": "ate",
              "value": "",
              "disabled": true,
              "description": "Início e fim do período, em AAAA-MM-DD, no horário de Brasília."
            },
            {
              "key": "q",
              "value": "",
              "disabled": true,
              "description": "Busca por número de telefone ou #pedido."
            }
          ]
        },
        "description": "Os pedidos da conta. Com desfecho=aberto, só os que ainda esperam ou já têm código."
      }
    },
    {
      "name": "Comprar números",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "X-API-Key",
            "value": "{{apiKey}}",
            "type": "text"
          },
          {
            "key": "Idempotency-Key",
            "value": "{{$guid}}",
            "type": "text"
          },
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/orders",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders"
          ]
        },
        "description": "Cobra o saldo e reserva o número. Mande o preço e a faixa que a cotação devolveu.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"band\": \"3f9a1c07b2e4d856\",\n  \"expected_price_cents\": 890,\n  \"service_slug\": \"whatsapp-wa\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "Ver um pedido",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "X-API-Key",
            "value": "{{apiKey}}",
            "type": "text"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/orders/:order_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            ":order_id"
          ],
          "variable": [
            {
              "key": "order_id",
              "value": "",
              "description": "O id do pedido."
            }
          ]
        },
        "description": "Um pedido, com os códigos que chegaram e a hora de cada um."
      }
    },
    {
      "name": "Cancelar e estornar",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "X-API-Key",
            "value": "{{apiKey}}",
            "type": "text"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/orders/:order_id/cancel",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            ":order_id",
            "cancel"
          ],
          "variable": [
            {
              "key": "order_id",
              "value": "",
              "description": "O id do pedido."
            }
          ]
        },
        "description": "Cancela um número sem código e devolve o valor ao saldo."
      }
    },
    {
      "name": "Concluir o pedido",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "X-API-Key",
            "value": "{{apiKey}}",
            "type": "text"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/orders/:order_id/confirm",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            ":order_id",
            "confirm"
          ],
          "variable": [
            {
              "key": "order_id",
              "value": "",
              "description": "O id do pedido."
            }
          ]
        },
        "description": "Diz que o código funcionou. Libera a vaga de número aberto."
      }
    },
    {
      "name": "Pedir outro SMS",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "X-API-Key",
            "value": "{{apiKey}}",
            "type": "text"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/orders/:order_id/retry",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "orders",
            ":order_id",
            "retry"
          ],
          "variable": [
            {
              "key": "order_id",
              "value": "",
              "description": "O id do pedido."
            }
          ]
        },
        "description": "Grátis. Pede outro código no mesmo número."
      }
    },
    {
      "name": "Cotar um serviço",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "X-API-Key",
            "value": "{{apiKey}}",
            "type": "text"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/quote?service_slug=&quantity=",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "quote"
          ],
          "query": [
            {
              "key": "service_slug",
              "value": "",
              "disabled": true,
              "description": "O serviço, como aparece no catálogo. Ex.: whatsapp-wa"
            },
            {
              "key": "quantity",
              "value": "",
              "disabled": true,
              "description": "Quantos números. Padrão 1."
            }
          ]
        },
        "description": "Todas as faixas de preço do serviço agora, com estoque. Não cobra nem reserva nada."
      }
    },
    {
      "name": "Listar serviços",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "X-API-Key",
            "value": "{{apiKey}}",
            "type": "text"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/services?q=",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services"
          ],
          "query": [
            {
              "key": "q",
              "value": "",
              "disabled": true,
              "description": "Filtra por nome. Ex.: whats"
            }
          ]
        },
        "description": "Os serviços à venda agora, com o preço a partir de. O slug é o que as outras rotas pedem."
      }
    }
  ]
}