Session

Session management

Get basic details of the logged in user

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

404

If you are not logged in

500

Internal Server Error

application/json

get

/v3/session/user

HTTPcURLJavaScriptPython

GET /v3/session/user HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

{
  "userId": 1,
  "userName": "text",
  "email": "text",
  "firstName": "text",
  "lastName": "text",
  "gender": "text",
  "phone": "text",
  "accessLevel": 1,
  "validateEmail": 1,
  "isTrialAccount": 1,
  "trialAccountExpirationDate": "text",
  "requestIp": "text",
  "requestIpCountry": "text",
  "requestIpCountryCode": "text",
  "details": {
    "accountType": 1,
    "companyName": "text",
    "vatNumber": "text",
    "cocNumber": "text",
    "firstName": "text",
    "lastName": "text",
    "address": "text",
    "streetNumber": "text",
    "zipCode": "text",
    "city": "text",
    "countryCode": "text",
    "emailAddress": "text",
    "unconfirmedEmail": {
      "email": "text",
      "expiresAt": 1
    },
    "emailAddressValidated": 1,
    "phoneNumber": "text",
    "phoneNumberMobile": "text",
    "language": 1,
    "emailAddressAbuse": "text",
    "newsletter": 1,
    "agreeToc": 1,
    "agreeAup": 1,
    "agreeDpa": 1,
    "isAllowedFlexMetal": 1
  },
  "billingDetails": {
    "firstName": "text",
    "lastName": "text",
    "address": "text",
    "streetNumber": "text",
    "zipCode": "text",
    "city": "text",
    "countryCode": "text",
    "phoneNumber": "text",
    "phoneNumberMobile": "text",
    "emailAddressBilling": "text",
    "bundleInvoicesOfSameCategory": 1,
    "receivePaymentConfirmationsViaEmail": 1,
    "preferredPaymentMethod": 1
  }
}

Log in

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

userNamestringRequired

User name

passwordstringRequired

Password

rememberMeinteger · integerOptional

Remember me

Responses

200

OK

application/json

401

Invalid credentials

409

Already logged in

429

Too many login requests performed

500

Internal Server Error

application/json

post

/v3/session/login

HTTPcURLJavaScriptPython

POST /v3/session/login HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "userName": "text",
  "password": "text",
  "rememberMe": 1
}

{
  "requiresOtp": true,
  "expiresAt": 1,
  "otpSessionExpiresAt": 1
}

Provide 2FA One-Time Password after a successful login (if requiresOtp is true in SessionAuthReq, as returned by /session/login)

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

otpstringRequired

6 digit One-Time Password

Responses

204

No Content

No content

401

Invalid OTP

404

Unexpected OTP call

500

Internal Server Error

application/json

post

/v3/session/login/otp

HTTPcURLJavaScriptPython

POST /v3/session/login/otp HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "otp": "text"
}

No content

Log out

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

204

No Content

No content

500

Internal Server Error

application/json

post

/v3/session/logout

HTTPcURLJavaScriptPython

POST /v3/session/logout HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content