Referência de fluxo de usuário da API Shrimpy Developer

>

As APIs Shrimpy Universal Crypto Exchange são um recurso poderoso para desenvolvedores de aplicativos de criptomoeda. As APIs fornecem soluções para alguns dos maiores problemas encontrados ao integrar a funcionalidade de troca de criptografia, incluindo:

  1. Execução de transações de baixa latência, roteamento inteligente de pedidos, & Estratégias Automatizadas

  2. Autorização do usuário & Gestão

  3. Integração de troca & Endpoint Unification

  4. Dados em tempo real & Analytics

Tirar proveito de tudo que as APIs Shrimpy têm a oferecer requer um entendimento de como as APIs funcionam e como os usuários são gerenciados. Esta referência irá guiá-lo através dos detalhes de como pensar conceitualmente sobre as APIs Shrimpy, discutir como os usuários podem ser gerenciados e destacar alguns dos fluxos de solicitação mais comuns. Uma vez que nossas APIs são uma solução de nível institucional projetada para permitir desenvolvimentos em grande escala, dominar este tópico permitirá que você dimensione perfeitamente seu aplicativo para milhões de usuários ativos e incontáveis ​​trocas.

Registre-se para uma conta de desenvolvedor Shrimpy API aqui. Não se esqueça de também se juntar ao nosso telegrama do desenvolvedor para se manter atualizado com as últimas notícias.

Gestão de câmbio – discussão conceitual

Este diagrama de alto nível mostra como o desenvolvedor não precisa gerenciar usuários diretamente, executar negociações ou integrar-se a cada bolsa individual. Os desenvolvedores realizam apenas uma única integração com as APIs Shrimpy para conectar cada um desses componentes importantes.

As APIs Shrimpy Universal Crypto Exchange são uma maneira simples para os desenvolvedores se conectarem a todas as principais bolsas por meio de endpoints consistentes. A integração de nossas APIs elimina a necessidade de código especializado para cada troca, reduz a demanda de atualizações esporádicas de troca, corta custos de infraestrutura de troca, aumenta a disponibilidade de dados, dimensiona perfeitamente para gerenciar um número ilimitado de usuários, acelera as velocidades de desenvolvimento e padroniza a forma como as negociações são executados em todas as principais bolsas.

Conceitualmente, Shrimpy é uma interface unificada para cada bolsa. Essa interface cria uma maneira uniforme de gerenciar todas as trocas. Sem as APIs do Shrimpy, a integração individual de uma troca pode levar semanas ou até meses para ser concluída. Mesmo após a conclusão, as trocas exigem atualizações e manutenção a um custo recorrente sem fim definitivo. Com as APIs do Shrimpy, a execução de uma negociação em uma bolsa é idêntica à execução de negociações em todas as outras bolsas. Nossa equipe gerencia atualizações, manutenção e integrações, para que você nunca mais precise se esforçar para se manter atualizado. Nossa lista de trocas com suporte está se expandindo constantemente e permite integração instantânea em seu aplicativo ou serviço sem nenhum trabalho adicional.

Alguns dos recursos que o Shrimpy oferece em todas as principais bolsas:

  • Dados do livro de pedidos em tempo real

  • Saldos de contas de câmbio

  • Ticker de mercado

  • Gestão de usuários

  • Negociação grátis com Coinbase Pro e KuCoin

  • Execução de pedidos em tempo real

  • Backtesting de alta fidelidade

  • Roteamento inteligente de pedidos

  • Rebalanceamento de portfólio automatizado

  • Insights de seleção de ativos

  • Webockets em tempo real para dados comerciais e de livro de pedidos

Como desenvolvedor de aplicativos, o problema é simplificado para uma única integração com as APIs Shrimpy.

Fluxos de solicitação de usuário

Existem 2 maneiras principais de o Shrimpy permitir que os desenvolvedores gerenciem convenientemente as solicitações dos usuários. O primeiro é um fluxo de solicitação (centralizado) controlado pelo desenvolvedor. O segundo método é um fluxo de solicitação controlado pelo usuário (descentralizado).

Além desses fluxos gerais de solicitação do usuário, também discutiremos padrões para outros fluxos de solicitação comuns que você provavelmente encontrará como desenvolvedor.

Fluxo de solicitação controlado pelo desenvolvedor (centralizado)

Um fluxo de solicitação controlado pelo desenvolvedor significa que cada solicitação enviada ao Shrimpy virá dos próprios servidores do desenvolvedor. Essencialmente, cada solicitação é encaminhada por um servidor centralizado que gerencia a comunicação com os servidores Shrimpy. Uma vez que os desenvolvedores podem criar Chaves de API Master Shrimpy que gerenciam cada usuário, os desenvolvedores podem enviar solicitações ao Shrimpy em nome de qualquer usuário, assinando as solicitações com as chaves API Master Shrimpy. As respostas a essas solicitações podem então ser encaminhadas de volta para o usuário por meio do servidor de desenvolvedor centralizado.

Esse fluxo é popular entre os desenvolvedores de aplicativos móveis. Os desenvolvedores de aplicativos móveis consideram esse fluxo de solicitação conveniente porque as alterações na maneira como os usuários se comunicam com o Shrimpy podem ser ajustadas rapidamente. Uma vez que o desenvolvedor controla os servidores que gerenciam as solicitações, as atualizações podem ser implantadas sem que os usuários atualizem seus aplicativos.

Por padrão, as chaves de API Master Shrimpy têm um limite de 1.000 solicitações por minuto. Os desenvolvedores que planejam enviar milhares de solicitações por minuto podem receber um aumento de limite de taxa enviando um e-mail para [email protected]

Para implementar um fluxo de solicitação controlado pelo desenvolvedor, use as seguintes etapas:

  1. Quando um usuário se inscreve em seu aplicativo ou serviço, reúna as informações necessárias para registrar esse usuário no Shrimpy. Recomendamos incluir um identificador exclusivo como e-mail no campo opcional “nome” ao criar um usuário com Shrimpy.

  2. Crie um novo usuário com Shrimpy. Esta ação é totalmente gratuita, então você pode fazer quantos usuários quiser. O desenvolvedor só será cobrado quando o usuário estiver “habilitado” para negociação. Shrimpy responderá com um ID de usuário único. Este pedido deve ser assinado com a chave mestra.

  3. Vincule o ID do usuário que Shrimpy retorna às informações do usuário que você armazenou em seu próprio sistema. Desta forma, você pode encaminhar adequadamente as solicitações de seus usuários para o Shrimpy.

  4. Permitir que cada usuário envie solicitações para vincular contas de câmbio, executar negociações, coletar dados e gerenciar seu portfólio. Neste fluxo de solicitação, você é responsável por manter essas conexões com os usuários e encaminhar adequadamente as solicitações para o Shrimpy.

  5. Roteie a solicitação para Shrimpy em nome de cada usuário. Use sua chave de API Master Shrimpy para assinar as solicitações apropriadas.

Fluxo de solicitação controlado pelo usuário (descentralizado)

A segunda opção de fluxo de solicitação do usuário que é possível com as APIs de desenvolvedor Shrimpy é um fluxo de solicitação controlado pelo usuário. Isso significa que cada usuário individual gerenciará suas próprias solicitações de negociação, coleta de dados e vinculação de contas de câmbio, comunicando-se diretamente com o Shrimpy. Cada uma dessas solicitações será assinada com as chaves de API individuais do usuário Shrimpy. Esses são não o mesmo que as chaves API Master Shrimpy. As chaves de API do usuário Shrimpy são exclusivas para cada usuário individual. NUNCA FORNECE CHAVES DE API MASTER SHRIMPY PARA OS USUÁRIOS.

Esse fluxo de usuário é acessível a todos os desenvolvedores, mas descobrimos que é particularmente desejável para desenvolvedores da web. Como os sites podem ser reimplantados rapidamente, não há risco de precisar migrar usuários se o site precisar ser atualizado. O benefício desse fluxo de solicitação é uma redução drástica na carga do servidor.

O diagrama acima ilustra como os desenvolvedores que implementam esse fluxo de solicitação ainda precisam de um servidor centralizado para iniciar a criação de usuários. Além da criação do usuário, o desenvolvedor também precisará gerar Chaves de API de usuário Shrimpy para cada usuário individual. Essas chaves são enviadas de volta ao usuário para que ele possa se comunicar diretamente com Shrimpy assinando solicitações de acesso à sua conta pessoal.

A implementação do fluxo de solicitação controlado pelo usuário exigirá as seguintes etapas:

  1. Quando um usuário se inscreve em seu aplicativo ou serviço, reúna as informações necessárias para registrar esse usuário no Shrimpy. Recomendamos incluir um identificador exclusivo como e-mail no campo opcional “nome” ao criar um usuário com Shrimpy.

  2. Crie um novo usuário com Shrimpy. Esta ação é totalmente gratuita, então você pode fazer quantos usuários quiser. O desenvolvedor só será cobrado quando o usuário estiver “habilitado” para negociação. Shrimpy responderá com um ID de usuário único. Este pedido deve ser assinado com a chave mestra.

  3. Solicitação para criar chaves de API do usuário Shrimpy para este usuário. Essas chaves são exclusivas para cada usuário individual e só podem assinar solicitações para a conta de usuário associada. A solicitação para gerar essas chaves é assinada pelas chaves da API Master Shrimpy.

  4. Roteie as chaves de API do usuário Shrimpy e a ID do usuário de volta para o usuário apropriado. Essas chaves serão usadas para se comunicar diretamente com Shrimpy.

  5. Cada um de seus usuários individuais agora pode se comunicar diretamente com Shrimpy assinando solicitações com as Chaves de API de usuário Shrimpy. Os usuários podem executar negociações, coletar dados, vincular contas de câmbio, gerenciar seu portfólio, executar backtests e muito mais assinando solicitações com suas chaves individuais.

Vinculando conta do Exchange

A discussão a seguir se concentrará no fluxo de solicitação para vincular contas de câmbio para um usuário e executar uma negociação. Embora este diagrama seja específico para o fluxo de solicitação controlado pelo usuário, o processo é essencialmente o mesmo para um fluxo de solicitação controlado pelo desenvolvedor. A principal diferença é que as solicitações serão assinadas com as chaves da API Master Shrimpy ao usar o fluxo de solicitação controlado pelo desenvolvedor.

Depois que um usuário recebe suas chaves de API do usuário Shrimpy, ele pode se comunicar diretamente com o Shrimpy para vincular trocas, executar negociações, coletar dados e muito mais. O processo de geração de uma chave de API do usuário Shrimpy é descrito na seção intitulada “Fluxo de solicitação controlado pelo usuário (descentralizado)”.

Para começar a executar negociações em uma bolsa, você deve primeiro vincular uma conta de câmbio para o usuário. Isso pode ser feito por meio das seguintes etapas:

  1. Vincule as chaves de API do Exchange do usuário ao Shrimpy usando o botão “Vincular uma conta Exchange”Endpoint. Chaves de API do Exchange não são iguais às Chaves de API do usuário Shrimpy. As chaves API do Exchange são obtidas e configuradas na troca. Essas chaves são específicas para cada conta de câmbio. Esta solicitação deve ser assinada com as chaves de API do usuário Shrimpy.

  2. Shrimpy se comunicará com o Exchange para verificar a conta do Exchange, coletar dados e gerenciar a conexão.

  3. Assim que a verificação for concluída, Shrimpy responderá com um ID de conta para a conta de troca que foi vinculada. Um usuário tem permissão para vincular até 20 contas de câmbio, então este ID de conta é a forma como o Shrimpy identifica cada conta de câmbio. Se seus usuários precisarem vincular mais de 20 contas de troca, entre em contato conosco em [email protected]

  4. O usuário agora pode solicitar ao Shrimpy para executar negociações, vincular mais contas de câmbio, executar backtests e muito mais. Essas solicitações devem ser assinadas com as chaves de API do usuário Shrimpy.

Alocação e reequilíbrio do portfólio de usuários

A discussão a seguir se concentrará no fluxo de solicitação para alocar um portfólio e configurar um rebalanceamento periódico para um usuário que já vinculou uma conta de troca ao Shrimpy. Embora este diagrama seja específico para o fluxo de solicitação controlado pelo usuário, o processo é essencialmente o mesmo para um fluxo de solicitação controlado pelo desenvolvedor. A principal diferença é que as solicitações serão assinadas com as chaves da API Master Shrimpy ao usar o fluxo de solicitação controlado pelo desenvolvedor.

Depois que um usuário se conecta a uma conta Exchange usando as etapas descritas em “Vinculando conta do Exchange”, Eles podem alocar um portfólio e definir uma estratégia.

Observação: o fluxo de solicitação para simplesmente colocar pedidos de limite, pedidos inteligentes ou coleta de dados é diferente deste fluxo de solicitação. Nenhum portfólio ou estratégia precisa ser definido para colocar pedidos de limite, executar pedidos inteligentes ou coletar dados; no entanto, uma conta de câmbio ainda precisa ser vinculada.

O processo para alocar um portfólio e definir uma estratégia de rebalanceamento com Shrimpy é o seguinte:

  1. Envie as alocações de portfólio para Shrimpy. Esta solicitação é assinada com as chaves de API do usuário Shrimpy.

  2. Solicite um rebalanceamento. Um rebalanceamento nesta instância simplesmente executará as negociações necessárias para construir o portfólio que foi especificado na etapa 1. Esta solicitação deve ser assinada com as chaves de API do usuário Shrimpy.

  3. Shrimpy se comunicará com a bolsa para coletar dados, executar as negociações e construir o portfólio desejado.

  4. Solicite periodicamente o status do rebalanceamento chamando o endpoint “Listar contas”. O usuário também pode acompanhar mais solicitações para executar negociações, coletar dados de saldo, acessar os dados de mercado mais recentes e muito mais. Essas solicitações são assinadas com as chaves de API do usuário Shrimpy.

Conclusões

As APIs Shrimpy são uma opção flexível para desenvolvedores de aplicativos que procuram uma solução baseada em nuvem que lida com os principais obstáculos para troca de comércio, coleta de dados, escalabilidade de produto e gerenciamento de usuário. Integre todas as principais bolsas com terminais consistentes, aproveitando nossa infraestrutura de negociação de criptografia universal. Simplifique os fluxos de solicitações do usuário aproveitando nossos novos padrões de design. Amplie seu serviço para milhões de usuários sem se preocupar.

Artigos relacionados

Shrimpy vs CCXT: o caso para centralização em um ecossistema descentralizado

Negociando criptografia por meio de APIs

Websockets universais para dados de livro de pedidos de troca de criptografia em tempo real

Dados históricos de gráficos comerciais OHLCV para trocas de criptografia

Crypto API para roteamento inteligente de pedidos

Mike Owergreen Administrator
Sorry! The Author has not filled his profile.
follow me