Criar Cliente
curl --request POST \
--url https://api.spedy.com.br/v1/customers \
--header 'Content-Type: application/json-patch+json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"legalName": "<string>",
"federalTaxNumber": "<string>",
"stateTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phone": "<string>",
"mobilePhone": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"code": "<string>",
"name": "<string>"
},
"cityName": "<string>"
}
}
'import requests
url = "https://api.spedy.com.br/v1/customers"
payload = {
"name": "<string>",
"legalName": "<string>",
"federalTaxNumber": "<string>",
"stateTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phone": "<string>",
"mobilePhone": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"code": "<string>",
"name": "<string>"
},
"cityName": "<string>"
}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
name: '<string>',
legalName: '<string>',
federalTaxNumber: '<string>',
stateTaxNumber: '<string>',
cityTaxNumber: '<string>',
email: '<string>',
phone: '<string>',
mobilePhone: '<string>',
address: {
street: '<string>',
district: '<string>',
postalCode: '<string>',
number: '<string>',
additionalInformation: '<string>',
city: {code: '<string>', name: '<string>'},
cityName: '<string>'
}
})
};
fetch('https://api.spedy.com.br/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.spedy.com.br/v1/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'legalName' => '<string>',
'federalTaxNumber' => '<string>',
'stateTaxNumber' => '<string>',
'cityTaxNumber' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'mobilePhone' => '<string>',
'address' => [
'street' => '<string>',
'district' => '<string>',
'postalCode' => '<string>',
'number' => '<string>',
'additionalInformation' => '<string>',
'city' => [
'code' => '<string>',
'name' => '<string>'
],
'cityName' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.spedy.com.br/v1/customers"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"legalName\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"stateTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"cityName\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.spedy.com.br/v1/customers")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"name\": \"<string>\",\n \"legalName\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"stateTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"cityName\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spedy.com.br/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"name\": \"<string>\",\n \"legalName\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"stateTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"cityName\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"legalName": "<string>",
"federalTaxNumber": "<string>",
"stateTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phone": "<string>",
"mobilePhone": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"code": "<string>",
"name": "<string>"
},
"country": {
"name": "<string>",
"code": 123
},
"cityName": "<string>"
}
}Clientes
Criar Cliente
Cadastra um cliente (destinatário das notas). Clientes pertencem à conta e são compartilhados por todas as empresas.
POST
/
v1
/
customers
Criar Cliente
curl --request POST \
--url https://api.spedy.com.br/v1/customers \
--header 'Content-Type: application/json-patch+json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"legalName": "<string>",
"federalTaxNumber": "<string>",
"stateTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phone": "<string>",
"mobilePhone": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"code": "<string>",
"name": "<string>"
},
"cityName": "<string>"
}
}
'import requests
url = "https://api.spedy.com.br/v1/customers"
payload = {
"name": "<string>",
"legalName": "<string>",
"federalTaxNumber": "<string>",
"stateTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phone": "<string>",
"mobilePhone": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"code": "<string>",
"name": "<string>"
},
"cityName": "<string>"
}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
name: '<string>',
legalName: '<string>',
federalTaxNumber: '<string>',
stateTaxNumber: '<string>',
cityTaxNumber: '<string>',
email: '<string>',
phone: '<string>',
mobilePhone: '<string>',
address: {
street: '<string>',
district: '<string>',
postalCode: '<string>',
number: '<string>',
additionalInformation: '<string>',
city: {code: '<string>', name: '<string>'},
cityName: '<string>'
}
})
};
fetch('https://api.spedy.com.br/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.spedy.com.br/v1/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'legalName' => '<string>',
'federalTaxNumber' => '<string>',
'stateTaxNumber' => '<string>',
'cityTaxNumber' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'mobilePhone' => '<string>',
'address' => [
'street' => '<string>',
'district' => '<string>',
'postalCode' => '<string>',
'number' => '<string>',
'additionalInformation' => '<string>',
'city' => [
'code' => '<string>',
'name' => '<string>'
],
'cityName' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.spedy.com.br/v1/customers"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"legalName\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"stateTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"cityName\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.spedy.com.br/v1/customers")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"name\": \"<string>\",\n \"legalName\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"stateTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"cityName\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spedy.com.br/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"name\": \"<string>\",\n \"legalName\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"stateTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"cityName\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"legalName": "<string>",
"federalTaxNumber": "<string>",
"stateTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phone": "<string>",
"mobilePhone": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"code": "<string>",
"name": "<string>"
},
"country": {
"name": "<string>",
"code": 123
},
"cityName": "<string>"
}
}Authorizations
Authorization By X-Api-Key inside request's header
Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Nome / Nome Fantasia
Maximum string length:
80Razão Social
Maximum string length:
80CPF / CNPJ / Doc estrangeiro
Maximum string length:
14Inscrição Estadual (opcional). Informar somente números ou ISENTO
Maximum string length:
20Inscrição Municipal
Maximum string length:
20Maximum string length:
50Telefone
Maximum string length:
15Celular
Maximum string length:
15Endereço
Show child attributes
Show child attributes
Response
Success
Nome / Nome Fantasia
Maximum string length:
80Razão Social
Maximum string length:
80CPF / CNPJ / Doc estrangeiro
Maximum string length:
14Inscrição Estadual (opcional). Informar somente números ou ISENTO
Maximum string length:
20Inscrição Municipal
Maximum string length:
20Maximum string length:
50Telefone
Maximum string length:
15Celular
Maximum string length:
15Endereço
Show child attributes
Show child attributes
⌘I