# BIS Safety Software REST API

> The BIS Safety Software REST API (v.01) lets customer systems read and update users, training records, topics, forms, datasets, locations, assets, classroom events, tasks and reward points. Get a bearer token from `POST /token` with an API credential (Admin > Setup > Integration > API Credentials).

Base URL: `https://www.bissafety.app/rest/v.01`

Authentication: call `POST /token` with your API credential to get a bearer token, then send `Authorization: Bearer <token>` with every call. The Open API endpoints take `client_id` and `client_secret` request headers instead.

## Docs

- [Introduction](https://www.bissafety.app/api-docs#introduction)
- [Response Codes](https://www.bissafety.app/api-docs#responsecode)
- [Authentication](https://www.bissafety.app/api-docs#auth): POST /token
- [Users](https://www.bissafety.app/api-docs#users)
  - [GET /user](https://www.bissafety.app/api-docs#user-list): List Users
  - [POST /user](https://www.bissafety.app/api-docs#user-import): Import Users
  - [GET /user/documents](https://www.bissafety.app/api-docs#user-documents): Get Documents
  - [POST /user/login](https://www.bissafety.app/api-docs#user-login): Login
  - [POST /user/siteactivity](https://www.bissafety.app/api-docs#site-activity): Site Activity
- [Training](https://www.bissafety.app/api-docs#training)
  - [GET /training](https://www.bissafety.app/api-docs#training-trainings): Completed Training
  - [GET /training/online](https://www.bissafety.app/api-docs#training-online): Online Course Result
  - [POST /training](https://www.bissafety.app/api-docs#pushrecord): Push Training Records
  - [GET /training/contentpoolcourses](https://www.bissafety.app/api-docs#contentpool-courses): Courses in Course Pool
  - [POST /training/createcoursecode](https://www.bissafety.app/api-docs#create-course-code): Create Course Code
  - [GET /training/courses](https://www.bissafety.app/api-docs#training-courses): Training Courses
- [Forms](https://www.bissafety.app/api-docs#forms)
  - [GET /form/response](https://www.bissafety.app/api-docs#forms-response): Get Form Data
  - [GET /form/completions](https://www.bissafety.app/api-docs#forms-completions): Get Completions
  - [GET /form](https://www.bissafety.app/api-docs#form-fields): Get Form Fields
  - [GET /form/completion-pdf](https://www.bissafety.app/api-docs#completion-pdf): Get Form PDF Link
- [Dataset](https://www.bissafety.app/api-docs#dataset)
  - [GET /dataset](https://www.bissafety.app/api-docs#list-datasets): List Datasets
  - [GET /dataset/records](https://www.bissafety.app/api-docs#get-dataset-records): Get Dataset Records
  - [POST /dataset/records](https://www.bissafety.app/api-docs#add-dataset-records): Add Dataset Records
  - [DELETE /dataset/records](https://www.bissafety.app/api-docs#delete-dataset-records): Delete Dataset Records
- [Location](https://www.bissafety.app/api-docs#location)
  - [GET /location](https://www.bissafety.app/api-docs#location-list): List Locations
  - [POST /location](https://www.bissafety.app/api-docs#location-import): Import Locations
  - [POST /location/status](https://www.bissafety.app/api-docs#location-status): Change Location Status
- [Training Topic](https://www.bissafety.app/api-docs#training-topic)
  - [GET /topic/details](https://www.bissafety.app/api-docs#topic-details): Topic Details
  - [GET /topic/assigned](https://www.bissafety.app/api-docs#topic-assigned): Topic Assigned
  - [GET /topic/status](https://www.bissafety.app/api-docs#topic-status): Topic Status
  - [GET /topic/reset](https://www.bissafety.app/api-docs#topic-reset): Topic Reset
  - [GET /topic/list](https://www.bissafety.app/api-docs#topic-list): Topic List
  - [GET /topic/status/delta](https://www.bissafety.app/api-docs#topic-status-delta): Topic Status Delta
- [Roles](https://www.bissafety.app/api-docs#role): GET /role
- [Task](https://www.bissafety.app/api-docs#task)
  - [GET /task](https://www.bissafety.app/api-docs#get-task): Get Tasks
- [E-Commerce](https://www.bissafety.app/api-docs#ecommerce-header)
  - [GET /products](https://www.bissafety.app/api-docs#ecommerce): Get Available Products
- [Asset](https://www.bissafety.app/api-docs#asset)
  - [GET /asset/categories](https://www.bissafety.app/api-docs#get-asset-categories): Get Asset Categories
  - [GET /asset](https://www.bissafety.app/api-docs#list-assets): List Assets
  - [POST /asset](https://www.bissafety.app/api-docs#save-asset): Save Asset
  - [GET /asset/requiredDocuments](https://www.bissafety.app/api-docs#get-asset-required-documents): Get Asset Required Documents
  - [POST /asset/requiredDocument](https://www.bissafety.app/api-docs#add-asset-required-document): Add Asset Required Document
  - [DELETE /asset/requiredDocument](https://www.bissafety.app/api-docs#delete-required-document): Delete Required Document
  - [GET /asset/documents](https://www.bissafety.app/api-docs#get-asset-documents): Get Asset Documents
  - [POST /asset/documents](https://www.bissafety.app/api-docs#add-asset-document): Add Asset Document
  - [POST /asset/documents/update](https://www.bissafety.app/api-docs#update-asset-document): Update Asset Document
  - [DELETE /asset/documents](https://www.bissafety.app/api-docs#delete-asset-document): Delete Asset Document
- [Classroom Event](https://www.bissafety.app/api-docs#event)
  - [GET /event](https://www.bissafety.app/api-docs#list-events): List Events
  - [GET /event/participants](https://www.bissafety.app/api-docs#event-participants): Get Event Participants
  - [PATCH /event/participants](https://www.bissafety.app/api-docs#patch-participants): Patch Event Participants
  - [POST /event/participants](https://www.bissafety.app/api-docs#post-participants): Add Event Participants
- [Webhooks](https://www.bissafety.app/api-docs#webhooks)
  - [POST https://your-endpoint](https://www.bissafety.app/api-docs#ccpush): Course Completion Event Hook
- [Single Sign-On (SSO)](https://www.bissafety.app/api-docs#sso)
  - [SAML 2.0 SSO](https://www.bissafety.app/api-docs#sso-saml)
  - [User Provisioning](https://www.bissafety.app/api-docs#user-provisioning)
  - [POST /user/token](https://www.bissafety.app/api-docs#sso-custom): Custom SSO
- [SFTP Import](https://www.bissafety.app/api-docs#sftp)
- [BambooHR Integration](https://www.bissafety.app/api-docs#bamboohr)
- [Open API](https://www.bissafety.app/api-docs#open-api)
  - [GET /training/verification](https://www.bissafety.app/api-docs#training-verification): Training Verification
  - [GET /training/networkpartners](https://www.bissafety.app/api-docs#network-parteners): Network Partners
- [Rewards](https://www.bissafety.app/api-docs#rewards)
  - [GET /reward/points](https://www.bissafety.app/api-docs#get-reward-points): Get Reward Points
  - [POST /reward/points](https://www.bissafety.app/api-docs#update-reward-points): Update Reward Points

## OpenAPI

- [OpenAPI 3.1 description](https://www.bissafety.app/openapi.json): import it into Postman, Swagger or a code generator

## Optional

- [llms-full.txt](https://www.bissafety.app/llms-full.txt): the full documentation in one file