Recursos da plataforma
Contas empresariais
Como chaves de API, orçamentos de membros, erros e logs se comportam quando uma equipe compartilha um saldo empresarial.
Uma conta empresarial permite que uma equipe inteira gaste a partir de um único saldo. O saldo da conta do proprietário passa a ser o saldo da empresa, cada membro chama a API com a própria chave e cada cobrança sai desse saldo compartilhado. Endpoints, corpos de requisição e configuração do cliente são os mesmos de uma conta pessoal; esta página trata apenas do que muda quando quem chama pertence a uma empresa.
Um membro envia uma solicitação
acme-…Com a própria chave, que começa com o prefixo da empresa.
Verificação do orçamento
O custo estimado precisa caber no que resta do orçamento do membro.
Cobrado da empresa
Pelos preços, grupos e assinatura da conta do proprietário.
Registrado em nome do membro
O proprietário e os administradores podem detalhá-lo por membro, modelo, chave e data.
Funções
Seção intitulada “Funções”| Função | Conta | O que pode fazer |
|---|---|---|
| Proprietário | A conta que fez a solicitação | O saldo dela é o saldo da empresa. Gerencia todos, recarrega o saldo e vê o uso de toda a empresa. Não pode ser desativada. |
| Administrador | Criada a partir de um convite | Chama a API dentro de um orçamento, convida e gerencia membros, recarrega o saldo e vê o uso de toda a empresa. |
| Membro | Criada a partir de um convite | Usa a API, a bancada de imagem e vídeo e o Castaly dentro de um orçamento. Não pode recarregar. |
Administradores e membros são contas novas criadas a partir de um convite por e-mail. O endereço convidado não pode estar registrado ainda, então uma conta pessoal existente não pode entrar em uma empresa. Essas contas não participam das recompensas da plataforma.
O proprietário e os administradores podem desativar uma conta a qualquer momento, e as sessões e chaves dela param de funcionar imediatamente. As contas são desativadas, nunca excluídas, então o histórico de uso permanece.
Chaves de API
Seção intitulada “Chaves de API”As chaves empresariais começam com o prefixo de chave da empresa, por exemplo acme- seguido de 48 letras e dígitos. Você escolhe o prefixo ao fazer a solicitação; ele é fixado na aprovação e não pode ser alterado depois. Um prefixo tem de 2 a 16 letras minúsculas e dígitos e começa com uma letra.
A mesma chave também funciona com sk- no lugar do prefixo. Use essa forma em qualquer cliente que só aceite chaves começando com sk-: as duas formas são a mesma chave, com as mesmas permissões e a mesma cobrança.
Authorization: Bearer acme-<48 characters>Authorization: Bearer sk-<48 characters>Uma chave apresentada com um prefixo que não é o da sua própria empresa é rejeitada como chave inválida com 401.
As chaves que o proprietário criou antes da aprovação da solicitação também aparecem com o prefixo da empresa. A forma com sk- continua funcionando, então as integrações existentes não precisam de mudanças.
Administradores e membros criam e veem apenas as próprias chaves no console. O proprietário e os administradores podem gerenciar todas as chaves da empresa no console empresarial, filtradas por membro.
Orçamentos dos membros
Seção intitulada “Orçamentos dos membros”Cada administrador e cada membro tem um orçamento. Nenhum dinheiro é transferido para eles; o orçamento é o máximo que podem gastar do saldo da empresa.
| Modo | Comportamento |
|---|---|
| Ilimitado | Limitado apenas pelo saldo da empresa. |
| Único | Uma cota fixa que nunca é redefinida sozinha. |
| Mensal | Recomeça do zero às 00:00 UTC do dia 1 de cada mês. |
Alterar apenas o limite mantém o valor já usado. Mudar para outro modo recomeça a contagem do zero.
Antes de uma solicitação ser executada, o gateway reserva o custo estimado no orçamento restante do membro e recusa a solicitação se ele não couber. Em seguida, a solicitação é liquidada pelo custo real. A liquidação nunca recusa, então a última solicitação pode deixar um membro um pouco acima do limite; a próxima é recusada. Quando uma solicitação falha ou é reembolsada, o valor também volta ao orçamento do membro.
Os membros recebem um e-mail quando usam 80% do orçamento e de novo quando ele acaba.
Cobrança, grupos e limites de requisições
Seção intitulada “Cobrança, grupos e limites de requisições”Para o gateway, a solicitação de um membro é uma solicitação da conta do proprietário. Tudo, exceto o orçamento, segue o proprietário:
- As cobranças saem do saldo da empresa da mesma forma que sairiam para o proprietário, incluindo a assinatura do proprietário.
- Preços, grupos e os modelos que uma chave pode chamar são os da conta do proprietário.
- Os limites de requisições valem para a empresa inteira. O proprietário e todos os membros compartilham uma única cota, então um
429pode ser causado pelo tráfego de outra pessoa.
Quando o saldo da empresa acaba, as solicitações de todos na empresa falham com 403 e insufficient_user_quota, como aconteceria em uma conta pessoal. O proprietário e os administradores podem recarregar pelo console empresarial; os membros não. Com um alerta de saldo configurado, o proprietário e os administradores recebem um e-mail quando o saldo fica abaixo dele.
| Situação | Estado | Como reconhecer |
|---|---|---|
| A chave traz o prefixo de outra empresa | 401 |
Rejeitada como chave inválida |
| O orçamento do membro acabou | 403 |
code é enterprise_member_budget_exhausted |
| O membro foi desativado ou a empresa foi suspensa | 403 |
message informa que a conta está desativada |
| O saldo da empresa acabou | 403 |
code é insufficient_user_quota |
| A empresa como um todo atingiu um limite de requisições | 429 |
Igual a uma conta pessoal |
Tentar de novo não resolve os casos 401 e 403. Um erro de orçamento some quando um administrador aumenta o limite ou, no orçamento mensal, quando começa o mês seguinte; um erro de saldo some depois de uma recarga.
Tarefas assíncronas
Seção intitulada “Tarefas assíncronas”Uma tarefa enviada com a chave de um membro só pode ser consultada com as chaves desse membro. Consultá-la com a chave de outro membro retorna o mesmo resultado de uma tarefa que não existe. As chaves do proprietário podem consultar tarefas enviadas por qualquer pessoa da empresa.
Uso e logs
Seção intitulada “Uso e logs”- Cada log de solicitação registra qual membro enviou a solicitação.
- No próprio console, administradores e membros veem apenas as próprias solicitações.
- A página de logs do proprietário mostra as solicitações de toda a empresa, com uma coluna extra de Membro.
- O proprietário e os administradores podem detalhar os gastos por membro, modelo, chave e data no console empresarial e abrir as solicitações individuais de qualquer membro.
- O período disponível segue a retenção de logs da conta do proprietário, veja Retenção de dados. Se o proprietário a encurtar, os relatórios da empresa encurtam junto.
Como obter uma conta empresarial
Seção intitulada “Como obter uma conta empresarial”Faça a solicitação no console da Modelflare com o nome da empresa, o prefixo de chave desejado e um e-mail de contato. Depois que a solicitação for aprovada, sua conta passa a ser a do proprietário, o saldo dela vira o saldo da empresa e você convida sua equipe pelo console empresarial. A página Empresas descreve o plano completo.