Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions website/docs/getting-started/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,15 @@ La API de Facturapi te permite crear, consultar y administrar los siguientes rec
Existen 2 roles distintos con los que puedes identificarte en la API:

- **Organización**. Identificarte como **organización** te permite emitir facturas usando la
información fiscal previamente configurada para la organización, así como crear, consultar y
realizar operaciones sobre recursos que le pertenezcan. Para identificarte con este rol,
deberás utilizar la **Test Secret Key** o la **Live Secret Key** de la organización,
dependiendo del **ambiente** que quieras utilizar.
- **Usuario**. Identificarte como usuario te permite crear y administrar
organizaciones que pertenecerán a tu cuenta de usuario. Para identificarte con este
rol, deberás utilizar la **User Secret Key** de tu cuenta.
información fiscal configurada para la organización, así como crear, consultar y
realizar operaciones sobre recursos que le pertenezcan. La **Live Secret Key** también puede
modificar la configuración operativa de su propia organización, como datos fiscales,
certificados, logotipo, autofactura y series. Para identificarte con este rol, deberás
utilizar la **Test Secret Key** o la **Live Secret Key** de la organización, dependiendo del
**ambiente** que quieras utilizar.
- **Usuario**. Identificarte como usuario te permite crear organizaciones, administrar
usuarios, roles, invitaciones y llaves API, y modificar organizaciones a las que tengas
acceso. Para identificarte con este rol, deberás utilizar la **User Secret Key** de tu cuenta.

## Ambientes

Expand Down Expand Up @@ -61,9 +63,9 @@ Sirven para identificar a una organización o a una cuenta de usuario al llamar

Existen 3 tipos de llaves secretas, cada una con una función específica:

- **Test Secret Key**: Identifica a la organización en ambiente Test para crear y administrar recursos (clientes, facturas, etc.). Es única por organización.
- **Live Secret Key**: Identifica a una Organización en ambiente Live para crear y administrar recursos (clientes, facturas, etc.). Es única por organización.
- **User Secret Key**: Identifica a tu cuenta para crear y configurar organizaciones. Es única por cuenta.
- **Test Secret Key**: Identifica a la organización en ambiente Test para crear y administrar recursos (clientes, facturas, etc.). También puede consultar la información de su propia organización, pero no modificar su configuración. Es única por organización.
- **Live Secret Key**: Identifica a una organización en ambiente Live para crear y administrar recursos (clientes, facturas, etc.) y para configurar su propia organización. Es única por organización.
- **User Secret Key**: Identifica a tu cuenta para crear organizaciones y administrar permisos, usuarios y llaves API. Es única por cuenta.

Las llaves secretas se utilizan durante el proceso de [autenticación](/docs/getting-started/authenticate).

Expand Down
8 changes: 8 additions & 0 deletions website/docs/getting-started/organization-onboarding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ sidebar_position: 1

Esta guía resume el checklist de configuración en dashboard para dejar tu organización lista para emitir CFDI.

También puedes automatizar la configuración operativa por API. Después de crear la organización,
puedes usar tu **User Secret Key** o la **Live Secret Key** de esa organización para actualizar
sus datos fiscales, CSD, logotipo, configuración de autofactura, recibos y series. La e.firma
(FIEL) solo es necesaria para la descarga masiva de CFDI; para crear CFDI basta con cargar el
CSD. La creación de organizaciones, la administración de usuarios y la administración de llaves
API siguen requiriendo una **User Secret Key**. La suscripción se activa desde el dashboard o el
flujo de billing correspondiente.

## Checklist de configuración inicial

### 1. Crear la organización
Expand Down
13 changes: 10 additions & 3 deletions website/docs/guides/organizations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,16 @@ Ese flujo puede resolverse desde API o directamente desde el dashboard, según
qué tanto necesites automatizar la administración del equipo.

:::info
Recuerda que para crear y administrar organizaciones deberás autenticarte usando tu User Key,
que es una llave secreta asociada a toda tu cuenta, la cual puedes encontrar en tu
[Centro de Integración](https://dashboard.facturapi.io/integration).
Para crear organizaciones, administrar usuarios, roles, invitaciones o llaves API deberás
autenticarte usando tu User Key, que es una llave secreta asociada a toda tu cuenta y que
puedes encontrar en tu [Centro de Integración](https://dashboard.facturapi.io/integration).

Una vez creada una organización, también puedes configurar sus datos operativos con tu User Key
o con la Live Secret Key (`sk_live_*`) de esa organización. Con la Live Secret Key puedes usar
`me` como alias de la organización, o enviar explícitamente el ID de la organización, en endpoints
como `/v2/organizations/me/legal`, `/v2/organizations/me/certificate`,
`/v2/organizations/me/customization` y `/v2/organizations/me/series-group`. La Test Secret Key
(`sk_test_*`) solo puede consultar la información de su propia organización.
:::

<Tabs groupId="codeExamples">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ The Facturapi API allows you to create, retrieve, and manage the following resou

There are 2 different roles that you can identify yourself with in the API:

- **Organization**: Identifying yourself as an organization allows you to issue invoices using the previously configured fiscal information for the organization, as well as create, retrieve, and perform operations on resources belonging to it. To identify yourself with this role, you must use the Test Secret Key or the Live Secret Key of the organization, depending on the environment you want to use.
- **User**: Identifying yourself as a user allows you to create and manage organizations that belong to your user account. To identify yourself with this role, you must use the User Secret Key of your account.
- **Organization**: Identifying yourself as an organization allows you to issue invoices using the configured fiscal information for the organization, as well as create, retrieve, and perform operations on resources belonging to it. The Live Secret Key can also update the operating configuration of its own organization, such as legal data, certificates, logo, self-invoice settings, receipts, and series. To identify yourself with this role, you must use the Test Secret Key or the Live Secret Key of the organization, depending on the environment you want to use.
- **User**: Identifying yourself as a user allows you to create organizations, manage users, roles, invites, API keys, and update organizations you have access to. To identify yourself with this role, you must use the User Secret Key of your account.

## Environments

Expand All @@ -48,13 +48,12 @@ They are used to identify an organization or a user account when calling the Fac

There are 3 types of secret keys, each with a specific function:

- **Test Secret Key**: Identifies the organization in the Test environment to create and manage resources (clients, invoices, etc.). It is unique per organization.
- **Live Secret Key**: Identifies an organization in the Live environment to create and manage resources (clients, invoices, etc.). It is unique per organization.
- **User Secret Key**: Identifies your account to create and configure organizations. It is unique per account.
- **Test Secret Key**: Identifies the organization in the Test environment to create and manage resources (clients, invoices, etc.). It can also read its own organization information, but it cannot update organization configuration. It is unique per organization.
- **Live Secret Key**: Identifies an organization in the Live environment to create and manage resources (clients, invoices, etc.) and configure its own organization. It is unique per organization.
- **User Secret Key**: Identifies your account to create organizations and manage permissions, users, and API keys. It is unique per account.

The secret keys are used during the authentication process.

To obtain your secret keys and create a free account on Facturapi, visit:

[https://www.facturapi.io/register](https://www.facturapi.io/register?utm_source=facturapi-docs&utm_medium=GithubPages)

Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ sidebar_position: 1

This guide summarizes the dashboard setup checklist to get your organization ready to issue CFDI.

You can also automate the operating configuration through the API. After creating the organization,
you can use your **User Secret Key** or that organization's **Live Secret Key** to update its legal
data, CSD, logo, self-invoice settings, receipts, and series. The e.firma (FIEL) is only required
for bulk CFDI downloads; to create CFDI you only need to upload the CSD. Organization creation,
user management, and API key management still require a **User Secret Key**. The subscription is
activated from the dashboard or the corresponding billing flow.

## Onboarding checklist

### 1. Create the organization
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,16 @@ That workflow can be handled either through the API or directly from the
dashboard, depending on how much team administration you want to automate.

:::info
Remember that to create and manage organizations, you must authenticate using your User Key,
which is a secret key associated with your entire account. You can find it in your
To create organizations, manage users, roles, invites, or API keys, you must authenticate using
your User Key, which is a secret key associated with your entire account. You can find it in your
[Integration Center](https://dashboard.facturapi.io/integration).

Once an organization exists, you can also configure its operating data with your User Key or with
that organization's Live Secret Key (`sk_live_*`). With the Live Secret Key, you can use `me` as
the organization alias, or send the organization ID explicitly, in endpoints such as
`/v2/organizations/me/legal`, `/v2/organizations/me/certificate`,
`/v2/organizations/me/customization`, and `/v2/organizations/me/series-group`. The Test Secret Key
(`sk_test_*`) can only read its own organization information.
:::

<Tabs groupId="codeExamples">
Expand Down
Loading