API Samba Vídeos

Toda a documentação técnica está disponível no site: https://dev.sambatech.com/

A API do SambaVideos segue o padrão REST, isto é, o webservice armazena e provê acesso aos dados através de requisições HTTP simples.

Cada uma das URLs (também chamadas endpoints) de um webservice que utiliza a filosofia RESTful é um “substantivo” que dá nome e identifica um recurso (ou um conjunto de recursos ou registros) que está disponível no webservice.

Base URL

O base da URL, ou endpoint raiz da API, deve ser adicionado ao início do caminho do recurso (ou lista de recursos) ao qual a chamada refere-se para realizar cada operação.

O Base-URL da API do Samba Videos é:

http://api.sambavideos.sambatech.com/v1

Requisições

  • POST: Criar ou habilitar um recurso no Samba Videos.
  • GET: Obter informações de uma lista de recursos ou um recurso único.
  • PUT: Atualizar um recurso no Samba Videos.
  • DELETE: Deletar ou desabilitar um recurso no Samba Videos.

Respostas padronizadas

  • 200 -  OK - O pedido foi realizado corretamente.
  • 201 - Created - O pedido foi realizado corretamente e o recurso criado.
  • 204 - No Content - O pedido foi realizado corretamente, porém, não há nada a ser retornado, ou seja, a resposta está vazia.
  • 400 - Bad Request - A sintaxe do pedido está mal formulada ou está faltando parâmetros requeridos na requisição.
  • 401 - Unauthorized - A autenticação falhou ou o usuário não possui as devidas permissões para a operação requisitada.
  • 403 - Forbidden - Acesso negado.
  • 404 - Not Found - O recurso requisitado não foi encontrado.
  • 405 - Method Not Allowed - O método em questão não é permitido.
  • 409 - Conflict - Ocorreu um conflito com um recurso já existente.
  • 500 - Internal Server Error - O servidor encontrou uma condição inesperada que o impediu de satisfazer o pedido.

Autenticação

API do Samba Vídeos foi desenvolvida utilizando o protocolo OAuth para autenticação. 

O OAuth é um protocolo de autorização de padrão aberto que permite que terceiros acessem os dados do usuário sem precisar saberem a senha dele. 

Em vez de usuários compartilhando suas senhas diretamente em um aplicativo, o OAuth serve como uma “chave de manobrista” que os aplicativos usam para acessar os dados de um usuário em seu lugar.

Para que a API seja consumida externamente, é necessário uma chave de acesso [access_token], que deverá ser fornecida por um aplicativo ativado na conta.

Gerando um Token (criar e ativar um aplicativo)

O fluxo para criação do aplicativo está na imagem a seguir:

Fluxo de criação de aplicativo

  1. Um usuário com perfil Desenvolvedor deve entrar no Samba Videos e acessar as "Configurações".

1-37

  2.   Na sequência vá no menu "Aplicações" e em "Criar aplicativo".

2-37

 3.  Nomeie o aplicativo e clique em "Criar" (não é necessário preencher nenhum outro campo).

3-29

 4.  O usuário Dono da conta deve então entrar no Samba Videos e ir em "Gerenciar Conta".

4-48

 5.  Vá em"Configurações de Conta" → "Aplicativos da conta" → "Instalar o aplicativo criado pelo usuário Desenvolvedor".

5-16

 6.  O usuário Desenvolvedor deve então ir em "Configurações" → "Aplicações e ativar o aplicativo ".

6-13

 7.  O token vai então estar disponível no local indicado a seguir.

7-11

 8.  Agora, basta  utilizar esse token na autenticação da API no campo [access_token].

CTA_blog-01