# Getting started One path through 4984 operations: two environment variables and one call that has been made before. :::note The operation below was selected by the filters printed on this page, from the same catalog the API reference is built from. ::: ## Before you start Three things have to be in place before step 1. They are listed rather than numbered because they are not a sequence — you need all three, in no particular order. | What you need | Where it comes from | | --- | --- | | A bearer token | Issued by the platform team that owns the deployment you are calling. Tokens are deployment-specific. | | A gateway address | The address of your deployment, supplied with your access. Each published OpenAPI document declares the address it was generated against; this page selects none of them, because a gateway belongs to one deployment. | | Network reach to that gateway | Your own network path — VPN, allow-list and TLS trust are configured on your side. Confirm the gateway is reachable from your machine before step 1. | ## The first call These five are a sequence, so they are numbered. Nothing else on this page is. 1. **Put the two values in your environment.** `AURA_TOKEN` is read by every one of the 6 code samples this build emits for this operation. `AURA_GATEWAY` is read by 5 of them — curl, JavaScript, Python, Java and C#. TypeScript is the exception: the base URL is resolved through the generated SDK's own helper rather than from the environment, so that sample needs the token from you and nothing else. `AURA_GATEWAY` is the gateway ROOT and carries no service segment: a caller-facing address is `//`, and every sample prints the service segment in the path. So one value works for every operation in this reference, whichever service it belongs to. ```bash export AURA_GATEWAY='https://' export AURA_TOKEN='' ``` **Both values are required.** Nothing after this step will produce a response without them — see the table above for where each comes from. 2. **Make the call.** `GET` `/account-constraints` in the [account](/api/account) domain, catalog code `get-account-constraint-list`. It was selected by the rule below, not chosen by anybody. ```bash curl -sS -i -X GET \ "$AURA_GATEWAY/account-service/account-constraints" \ -H 'Accept: application/json' \ -H "Authorization: Bearer $AURA_TOKEN" ``` This authenticated sample is generated by the portal's own sample builder. The API reference uses a separate multi-language sample generator; the published OpenAPI declares no security scheme, so those operation samples omit `Authorization` and Try it does not add a token automatically. Add the header manually there, as the notice on every operation explains. 3. **Read what comes back.** The catalog declares the response as a JSON `array` of a record with **7** properties. **Answered live.** This portal has itself received a `200` from this operation, with a JSON `array` body, in a read-only run against one running deployment. That is why it is the operation on this page. Your deployment carries its own catalog entries and may answer differently. Failure responses are documented on the operation pages: each declares the platform error envelope and the statuses a mapped failure arrives on, and most list the specific codes that operation raises. 4. **If it is refused.** Run the command above before you try the console in the API reference: the console is subject to the gateway's CORS policy and a `curl` is subject to none of it, so the two failing differently tells you which of the two problems you have. A call refused at the gateway never reaches a service and raises no platform error, so the status and body it returns are the whole account of it. Take those to the platform team that owns your gateway. 5. **Go from one operation to the rest.** Everything after this is reference material. The API reference is one document per domain, and search is a keystroke away from any page in this build. ## How this operation was chosen Not by preference. 4984 operations went in — the ones belonging to a domain this artifact publishes. Each filter below removed the ones a reader could not call without something they do not have yet, and the operation above is the FIRST of the 190 survivors under the catalog's own sort — domain, then route, then method. It is a row of a sorted list, not a recommended starting point, and this portal has no basis for naming one of those. | Filter | Why a reader needs it | Operations left | | --- | --- | --- | | the method is `GET` | a first call must not change anything in a live bank | **2108** | | the route carries no path parameter | a route with `{id}` in it needs an identifier the reader does not have yet | **752** | | no parameter is required | nothing has to be supplied before the operation will answer | **734** | | no request body is declared | nothing has to be constructed and sent | **719** | | a `200` response schema is declared | so this page can say what success looks like from the catalog rather than from a guess | **428** | | this portal has received a `200` from it | the first call a reader makes has been made before, by this repository, against a running deployment | **190** | ## The other operations the same rule selects 190 operations across 31 domains satisfy every filter above. The first 10 are listed so that the one at the top of this page is visibly a row in a set rather than a pick — any of these is as good a first call, and the rule that produced them is in the table above. | Operation | Domain | Route | | --- | --- | --- | | `get-account-constraint-list` | [account](/api/account) | `GET` `/account-constraints` | | `get-account-list` | [account](/api/account) | `GET` `/accounts` | | `get-account-passbook-count-list` | [account](/api/account) | `GET` `/accounts/passbooks/count` | | `get-cash-box-list` | [account](/api/account) | `GET` `/cashs` | | `get-cash-user-map-list` | [account](/api/account) | `GET` `/cashs/user-map` | | `account-get-key-format-list` | [account](/api/account) | `GET` `/key-formats` | | `account-get-localization-list` | [account](/api/account) | `GET` `/localizations` | | `account-get-matrix-list` | [account](/api/account) | `GET` `/matrix` | | `account-get-parameter-list` | [account](/api/account) | `GET` `/parameters` | | `get-accounting-entry-list` | [accounting](/api/accounting) | `GET` `/accounting-entries` | ## Where to go next - [The API reference](/api): 43 documents, one per domain, with a console on every operation. - [The downloads](/downloads): the same OpenAPI documents, as files. - Whatever else this build emitted is in the sidebar, and search is a keystroke away from any page in it.