CADBase Platform API reference
Welcome here. This describes the application programming interface (API) of the CADBase Platform. The platform for storing and exchanging data between members of the mechanical engineering industry and others involved in inventing.
This platform has a 3D viewer for stl files and support for file versioning, which allows you to get some protection against data loss or violation of its integrity.
One of the features of the platform is the file sets included in component modifications. A component modification can contain several sets of files with which different CAD, CAE, CAM, etc. can interact.
License
MIT
Terms of Service
API Endpoint
# Production:
https://api.cadbase.rs/graphql
Authorization token
The main API of the CADBase platform is the GraphQL API, but the REST API is used to obtain the authorization token.
Bearer authentication (also called token authentication) is an HTTP authentication scheme that uses security tokens called bearer tokens. The name “Bearer Authentication” can be understood as “grant access to the bearer of this token”.
Use the https://api.cadbase.rs/login endpoint to obtain a new authorization token.
In most cases, when interacting with the CADBase platform via GraphQL API, clients need to specify this token in the authorization header.
Example of header element:
Authorization: "Bearer YOUR_TOKEN"
The bearer token is a cryptic string containing technical and user data.
Request:
curl \
-X POST \
-H "Content-Type: application/json" \
-d '{
"user": {
"username": "YOUR_USERNAME",
"password": "YOUR_PASSWORD"
}
}' \
https://api.cadbase.rs/login
Response:
{
"bearer": "YOUR_TOKEN"
}Queries
companies
Response
Returns [ShowCompanyShort!]!
Arguments
| Name | Description |
|---|---|
args - IptCompaniesArg
|
|
paginate - IptPaginate
|
Example
Query
query Companies(
$args: IptCompaniesArg,
$paginate: IptPaginate
) {
companies(
args: $args,
paginate: $paginate
) {
uuid
shortname
inn
description
imageFile {
uuid
hash
filename
filesize
downloadUrl
}
region {
regionId
langId
region
}
companyType {
companyTypeId
langId
name
shortname
}
isSupplier
isFollowed
updatedAt
}
}
Variables
{
"args": IptCompaniesArg,
"paginate": IptPaginate
}
Response
{
"data": {
"companies": [
{
"uuid": "bb547ed6-8248-4685-9b4e-683ccc0d0b2b",
"shortname": "xyz789",
"inn": "abc123",
"description": "xyz789",
"imageFile": DownloadFile,
"region": RegionTranslateList,
"companyType": CompanyTypeTranslateList,
"isSupplier": true,
"isFollowed": true,
"updatedAt": NaiveDateTime
}
]
}
}