Zoop Developer Center

Bem-vindo ao hub do desenvolvedor Zoop. Você encontrará guias da API e uma documentação abrangente para ajudá-lo a começar a trabalhar com a Zoop o mais rápido possível, além de ajudá-lo se você tiver algum problema. Vamos lá!

Documentação

Guia de implementação

Criando uma nova conta de acesso ao Minha Conta

Você pode criar uma nova conta para o Minha Conta pela API através das chamadas abaixo, sendo possível informar em uma única requisição os dados do estabelecimento comercial e os dados de acesso, usuário e senha, ao Minha Conta.

A solicitação ira criar um novo seller, sendo retornado os dados do estabelecimento criado, e enviará automaticamente para o email informado no campo username uma mensagem de boas vindas ao Minha Conta. O cliente deverá acessar o sistema com a senha informada na criação da conta, sendo obrigatório após o primeiro acesso a validação do e-mail, seguida da alteração da senha informada na criação da conta.

curl --request POST \
    --header "Content-Type: application/json" \
    --user zpk_test_EzCkzFFKibGQU6HFq7EYVuxI: \
    --url https://api.zoop.ws/v1/marketplaces/3249465a7753536b62545a6a684b0000/sellers/create \
    --data '{
    "type": "individual",
    "first_name": "Jose",
    "last_name": "Coves",
    "email": "email@meudominioo.com",
    "phone_number": "21 99988-22244",
    "taxpayer_id": "11717890091",
    "birthdate": "1986/12/07",
    "website": "http://pagzoop.com",
    "facebook": "https://www.facebook.com/zoop",
    "twitter": "http://twitter.com/zoop",
    "address": {
        "line1": "Avenida das Américas, 700",
        "line2": "Bloco 5",
        "line3": "Sala 101",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "neighborhood": "Barra da Tijuca",
        "postal_code": "22640-100",
        "country_code": "BR"
    },
    "user": {
        "username": "email@meudominioo.com",
        "password": "Senha123"
    }
}'
curl --request POST \
    --header "Content-Type: application/json" \
    --user zpk_test_EzCkzFFKibGQU6HFq7EYVuxI: \
    --url https://api.zoop.ws/v1/marketplaces/3249465a7753536b62545a6a684b0000/sellers/create \
    --data '{
    "type": "business",
    "business_name": "Bar do Joao",
    "business_phone": "+12026256754",
    "business_email": "email@meudominioo.com",
    "business_website": "http://getzoop.com",
    "business_description": "Bar do João",
    "business_facebook": "http://fb.com/getzoop",
    "business_twitter": "http://twitter.com/getzoop",
    "ein": "45245350000156",
    "statement_descriptor": "Squad QA Global",
    "business_opening_date": "2016-05-12",
    "owner": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "qa@zoop.co",
        "phone_number": "+55 21 66666-6666",
        "taxpayer_id": "28683715078",
        "birthdate": "1666-06-06"
    },
    "owner_address": {
        "line1": "Av Nameless",
        "line2": "Nowhere",
        "line3": "QA",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "postal_code": "77777-77",
        "country_code": "BR"
    },
    "business_address": {
        "line1": "Avenida Zoop",
        "line2": "Città América",
        "line3": "QA",
        "neighborhood": "Brahma Church",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "postal_code": "24000-000",
        "country_code": "BR"

    },
    "user": {
        "username": "email@meudominioo.com",
        "password": "Senha123"
    }
}'

Convidando usuário para acessar conta de EC existente

Caso você já tenha criado previamente um estabelecimento comercial através das APIs de criação de seller e não tenha informado o username e password, não se preocupe, você pode criar um credencial de acesso a qualquer momento fazendo uma solicitação de criação de usuário, informando o username, incluindo a permissão do tipo customers, conforme exemplo abaixo. Lembre-se de informar o id do seller no campo customer_id.

A solicitação ira criar um novo usuário de acesso e enviará automaticamente para o email informado no campo username uma mensagem de boas vindas ao Minha Conta com as informações para criação da senha. O cliente deverá acessar o sistema através do link informado no e-mail de boas vindas, sendo obrigatório após o primeiro acesso a validação do e-mail e criação da senha de acesso.

curl --request POST \
    --header "Content-Type: application/json" \
    --user zpk_test_EzCkzFFKibGQU6HFq7EYVuxI: \
    --url "https://api.zoop.ws/v1/marketplaces/3249465a7753536b62545a6a684b0000/users?invite" \
    --data '{
    "username": "email@meudominioo.com",
    "permissions": [{
        "type": "model",
        "model_name": "customers",
        "customer_id": "{{SELLER_ID}"
    }]
}'

Criando credenciais de acesso para conta de EC existente

Caso você já tenha criado previamente um estabelecimento comercial através das APIs de criação de seller e não tenha informado o username e password, não se preocupe, você pode criar um credencial de acesso a qualquer momento fazendo uma solicitação de criação de usuário, informando o username e password, incluindo a permissão do tipo customers, conforme exemplo abaixo. Lembre-se de informar o id do seller no campo customer_id.

A solicitação ira criar um novo usuário de acesso com as credenciais informadas, e NÃO enviará e-mail de boas vindas ao Minha Conta. O cliente deverá acessar o sistema através do link do seu marketplace com as credenciais informadas na solicitação.

curl --request POST \
    --header "Content-Type: application/json" \
    --user zpk_test_EzCkzFFKibGQU6HFq7EYVuxI: \
    --url "https://api.zoop.ws/v1/marketplaces/3249465a7753536b62545a6a684b0000/sellers/{SELLER_ID}/users" \
    --data '{
    "username": "email@meudominioo.com",
    "password": "minhasenhasegura123",
    "permissions": [{
        "type": "model",
        "model_name": "customers",
        "customer_id": "{SELLER_ID}"
    }]
}'

Guia de implementação


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.