Conceitos e fundamentos
Compreendendo os conceitos básicos
A API C2C se baseia em várias tecnologias essenciais que você deve compreender antes de iniciar um projeto de integração. Analise os títulos deste artigo.Se algum termo lhe for desconhecido, este guia ajudará a preencher essas lacunas de conhecimento. Caso encontre dificuldades com conceitos específicos, nossa equipe está à disposição para fornecer recursos adicionais e suporte.
O que você precisa saber
Para realizar uma integração bem-sucedida com a API C2C, você deve ter um conhecimento básico sobre:
Noções básicas de rede e glossário
Em essência, a API do Frame.io permite a comunicação entre os servidores do Frame.io e seu dispositivo ou aplicativo, exigindo interações de rede para cada operação.
Uma comunicação clara é essencial em qualquer relação, inclusive entre servidores e clientes. Assim como ocorrem falhas de comunicação nas conversas do dia a dia, desafios semelhantes existem quando os computadores trocam informações.
Além de lidar com problemas comuns de comunicação, precisamos garantir a transmissão segura de dados confidenciais. O Frame.io exige criptografia para todas as comunicações com o servidor, adicionando as camadas de segurança necessárias ao processo.
Ao implementar a API C2C, você provavelmente utilizará bibliotecas de terceiros para lidar com os detalhes de rede. No entanto, como os componentes de rede frequentemente geram erros reais, é importante compreender os processos subjacentes ao interagir com os servidores do Frame.io. Aqui está um glossário conciso da terminologia essencial:
Chaves públicas e privadas
Uma chave pública funciona como uma fechadura, enquanto uma chave privada serve como a chave correspondente.
Pense neste cenário: você quer enviar uma mensagem confidencial para um colega, garantindo a privacidade até a entrega.
Primeiro, peça para seu colega enviar uma fechadura da qual só ele tem a chave.
Ao receber essa fechadura, proteja sua mensagem confidencial em um contêiner usando-a. Embora qualquer pessoa que manuseie o contêiner possa ver a fechadura, apenas seu colega tem a chave para acessar o conteúdo. A fechadura não tem utilidade alguma para pessoas não autorizadas que tentem visualizar a mensagem. Nem mesmo você pode destrancá-la sem a chave.
Quando seu colega receber o contêiner protegido, ele simplesmente usará sua chave para acessar o conteúdo.
As chaves públicas e privadas funcionam da mesma maneira. Você pode compartilhar amplamente uma chave pública. Os destinatários criptografam mensagens com essa chave, mas apenas o portador da chave privada pode descriptografar essas comunicações. Enquanto a chave privada permanecer confidencial, a chave pública não poderá ser usada para decodificar as mensagens criptografadas que ela gera.
Esse mecanismo de chaves públicas/privadas sustenta a funcionalidade do TLS, permitindo que as partes se comuniquem abertamente enquanto estabelecem canais seguros e privados.
Certificados
Os certificados contêm chaves públicas e privadas, autenticadas por autoridades de certificação confiáveis.
Quando uma Autoridade certificadora valida uma chave, ela basicamente atesta a autenticidade dessa chave. Os destinatários de uma chave pública, como a do Google, podem verificar esse endosso por meio de autoridades de certificação reconhecidas. Chaves não endossadas são consideradas potencialmente fraudulentas e acionam alertas de segurança.
Os certificados do Frame.io são validados pela autoridade certificadora Amazon Root CA 1. Esses certificados estão disponíveis por meio de vários recursos, incluindo a biblioteca Certifi (usada pela Mozilla e pela biblioteca Python Requests).
Para implementação, recomendamos o repositório GitHub Certifi e o pacote de certificados PEM para validar solicitações HTTPS para api.frame.io.
Solicitações HTTP/S
O HTTP é onipresente na navegação na web, aparecendo no início de quase todos os endereços de sites. O HTTP (Protocolo de transferência de hipertexto) estabelece protocolos padronizados de comunicação entre computadores.
Você pode pensar no HTTP como um sistema padronizado de formulários para interações cliente-servidor, semelhante aos formulários governamentais exigidos para solicitações de informações ou inscrições em programas. Sem formulários devidamente preenchidos, os órgãos governamentais não podem processar ou responder às solicitações.
As solicitações HTTP facilitam todas as interações do aplicativo Frame.io. Dentro da estrutura da API C2C, os tipos de solicitação HTTP representam os recursos funcionais disponíveis.
Para uma visão geral abrangente do HTTP, consulte este artigo informativo. É essencial compreender esses fundamentos antes de prosseguir. Se você não tem familiaridade com solicitações HTTP, considere revisar os materiais introdutórios. Para uma preparação ideal, familiarize-se com estes conceitos de HTTP:
Embora as bibliotecas de rede geralmente cuidem da construção das solicitações, o RFC HTTP/1.1 fornece um recurso de referência, caso seja necessário.
Autenticação e autorização
Exploraremos esses conceitos mais detalhadamente posteriormente, mas é importante compreender esses princípios fundamentais:
Próximas etapas
Recomendamos que você entre em contato com nossa equipe caso tenha alguma dúvida e depois prossiga para a próxima seção do guia. Esperamos poder apoiar seus esforços de integração.
Para uma visão geral técnica, consulte o guia de arquitetura de integração. Caso ainda não tenha feito isso, revise o guia Implementação do C2C: Configuração antes de prosseguir. Você precisará do access_token obtido durante o processo de autenticação e autorização.