# Ofiniti Developer Documentation ## Docs - [Welcome](https://docs.ofiniti.com/index.md): To the Ofiniti developer documentation. - [API integration guide](https://docs.ofiniti.com/fuelboss/api-integration-guide.md): Integrate with the FuelBoss API: authentication, nominations, operations, documents, and webhooks for real-time notifications. - [Get OAuth 2.0 access token](https://docs.ofiniti.com/api-reference/oauth/get-oauth-20-access-token.md): Exchange client credentials for an access token using the OAuth 2.0 Client Credentials Grant flow. - [Accepts an existing nomination](https://docs.ofiniti.com/api-reference/nominations/accepts-an-existing-nomination.md): Accepts a nomination by client reference, indicating it is ready from the supplier side. - [Cancels an existing nomination](https://docs.ofiniti.com/api-reference/nominations/cancels-an-existing-nomination.md): Cancels a nomination by client reference. The nomination will be marked as cancelled and removed from active scheduling. - [Reschedules an existing nomination (deprecated)](https://docs.ofiniti.com/api-reference/nominations/reschedules-an-existing-nomination-deprecated.md): Deprecated. Use the Upsert Nomination endpoints (PUT /v1/nominations/supplier or PUT /v1/nominations/receiver) to update the scheduling information of an existing nomination. - [Retrieves a specific nomination](https://docs.ofiniti.com/api-reference/nominations/retrieves-a-specific-nomination.md): Retrieves a specific nomination by client reference. The client reference must be unique within your company and you can only access nominations belonging to your authenticated company. If more than one accessible nomination shares the client reference, a 422 is returned pointing to GET /v1/nominati… - [Lists nominations sharing a client reference](https://docs.ofiniti.com/api-reference/nominations/lists-nominations-sharing-a-client-reference.md): Returns every nomination with the given client reference that your company can access. Use this to disambiguate when GET /v1/nominations/{clientReference} returns 422. - [Retrieves draft nominations](https://docs.ofiniti.com/api-reference/nominations/retrieves-draft-nominations.md): Retrieves all draft nominations belonging to your company. - [Creates or updates a draft nomination](https://docs.ofiniti.com/api-reference/nominations/creates-or-updates-a-draft-nomination.md): Creates a new draft nomination or updates an existing one based on the client reference. Uses idempotency to prevent duplicate submissions. - [Creates or updates a nomination as a receiver](https://docs.ofiniti.com/api-reference/nominations/creates-or-updates-a-nomination-as-a-receiver.md): Creates a new nomination or updates an existing one based on the client reference. Uses idempotency to prevent duplicate submissions - [Creates or updates a nomination as a supplier](https://docs.ofiniti.com/api-reference/nominations/creates-or-updates-a-nomination-as-a-supplier.md): Creates a new nomination or updates an existing one based on the client reference. Uses idempotency to prevent duplicate submissions - [Retrieves all entities available for your company](https://docs.ofiniti.com/api-reference/entity-management/retrieves-all-entities-available-for-your-company.md): Retrieves all entities available for your company - [Retrieves all contracts available for your company](https://docs.ofiniti.com/api-reference/entity-management/retrieves-all-contracts-available-for-your-company.md): Retrieves a list of all contracts available for your company - [Creates or updates a contract](https://docs.ofiniti.com/api-reference/entity-management/creates-or-updates-a-contract.md): Creates a new contract or updates an existing one based on the contract reference. - [Retrieves all counterpart entities available for your company](https://docs.ofiniti.com/api-reference/entity-management/retrieves-all-counterpart-entities-available-for-your-company.md): Retrieves all counterpart entities available for your company - [Creates or updates a counterpart entity](https://docs.ofiniti.com/api-reference/entity-management/creates-or-updates-a-counterpart-entity.md): Creates a new or updates an existing one based on the reference - [Retrieves a specific operation](https://docs.ofiniti.com/api-reference/operations/retrieves-a-specific-operation.md): Retrieves specific operation and BDN data by client reference. The client reference must be unique within your company and you can only access operations belonging to your authenticated company. - [Retrieves a specific document file for an operation](https://docs.ofiniti.com/api-reference/operations/retrieves-a-specific-document-file-for-an-operation.md): Retrieves a document file by its unique identifier. The document ID is obtained from the operation's documents list. The client reference must be unique within your company and you can only access operations belonging to your authenticated company. Content type varies by document (PDF, JPEG, PNG etc… - [Retrieves the merged documents file for a specific operation](https://docs.ofiniti.com/api-reference/operations/retrieves-the-merged-documents-file-for-a-specific-operation.md): Retrieves a specific merged documents file by client reference. The client reference must be unique within your company and you can only access operations belonging to your authenticated company. Only available for operations signed using FuelBoss InBrowser™ signing. - [Retrieves asset operator relationships and their allowed entities](https://docs.ofiniti.com/api-reference/common/retrieves-asset-operator-relationships-and-their-allowed-entities.md): Retrieves the companies the current user's company operates assets for, and the companies the current user's company has appointed as its asset operators, along with the allowed company entities for each. - [Retrieves all companies available](https://docs.ofiniti.com/api-reference/common/retrieves-all-companies-available.md): Retrieves all companies available for creating nominations - [Retrieves all fuel types available](https://docs.ofiniti.com/api-reference/common/retrieves-all-fuel-types-available.md): Retrieves all fuel types available for creating nominations - [Retrieves all operation standards available](https://docs.ofiniti.com/api-reference/common/retrieves-all-operation-standards-available.md): Retrieves all operation standards available for creating nominations - [Retrieves all webhook subscriptions](https://docs.ofiniti.com/api-reference/webhooks/retrieves-all-webhook-subscriptions.md): Retrieves all webhook subscriptions for your tenant - [Creates a webhook subscription](https://docs.ofiniti.com/api-reference/webhooks/creates-a-webhook-subscription.md): Creates a new webhook subscription for the specified events - [Deletes a webhook subscription](https://docs.ofiniti.com/api-reference/webhooks/deletes-a-webhook-subscription.md): Deletes a webhook subscription - [Bunkering end time changed](https://docs.ofiniti.com/api-reference/webhook-events/bunkering-end-time-changed.md): Sent when a nomination's estimated bunkering end time (estimated time of completion, i.e. start time plus duration) changes. A start time change also moves the end time, so both events are typically delivered together; a duration-only change delivers only this event. - [Bunkering location changed](https://docs.ofiniti.com/api-reference/webhook-events/bunkering-location-changed.md): Sent when a nomination's bunkering location changes. - [Bunkering start time changed](https://docs.ofiniti.com/api-reference/webhook-events/bunkering-start-time-changed.md): Sent when a nomination's estimated bunkering start time (the "BST") changes, whether the change was made through an endpoint or the FuelBoss web application (reschedule, supplier/receiver update, amend, etc.). - [Nomination cancelled](https://docs.ofiniti.com/api-reference/webhook-events/nomination-cancelled.md): Sent when a nomination is cancelled. - [Company entity changed](https://docs.ofiniti.com/api-reference/webhook-events/company-entity-changed.md): Sent when the supplier company entity assigned to a nomination changes. - [Contract changed](https://docs.ofiniti.com/api-reference/webhook-events/contract-changed.md): Sent when the contract assigned to a nomination changes. - [Counterpart entity changed](https://docs.ofiniti.com/api-reference/webhook-events/counterpart-entity-changed.md): Sent when the counterpart entity assigned to a nomination changes. - [Nomination created](https://docs.ofiniti.com/api-reference/webhook-events/nomination-created.md): Sent when a nomination is created. - [Draft nomination upserted](https://docs.ofiniti.com/api-reference/webhook-events/draft-nomination-upserted.md): Sent when a draft nomination is created or updated. Use together with [Get Draft Nominations](/api-reference/nominations/retrieves-draft-nominations) to react to drafts as they are progressively assembled. - [Fuel specification changed](https://docs.ofiniti.com/api-reference/webhook-events/fuel-specification-changed.md): Sent when a nomination's fuel specifications change. - [Receiver vessel changed](https://docs.ofiniti.com/api-reference/webhook-events/receiver-vessel-changed.md): Sent when a nomination's receiver vessel changes. - [Supplier asset changed](https://docs.ofiniti.com/api-reference/webhook-events/supplier-asset-changed.md): Sent when a nomination's supplier asset changes. - [Operation ended](https://docs.ofiniti.com/api-reference/webhook-events/operation-ended.md): Sent when a bunkering operation ends. - [Operation started](https://docs.ofiniti.com/api-reference/webhook-events/operation-started.md): Sent when a bunkering operation starts. - [Changelog](https://docs.ofiniti.com/fuelboss/changelog.md): New features, improvements, and fixes in the FuelBoss API. ## OpenAPI Specs - [fuelboss-api](https://docs.ofiniti.com/specs/fuelboss/fuelboss-api.json) ## Optional - [FuelBoss Design System](https://design.ofiniti.com/)