logo
Documentation Powered by ReDoc

SmartI18N API (2.0.0-SNAPSHOT)

Download OpenAPI specification:Download

E-mail: mail@smarti18n.com URL: https://smarti18n.com License: Apache 2.0

Authentication

basic_auth_user

authentication with user mail and user password

Security Scheme Type HTTP
HTTP Authorization Scheme basic

basic_auth_superuser

authentication with user mail and user password. User has to be a superuser.

Security Scheme Type HTTP
HTTP Authorization Scheme basic

basic_auth_project

authentication with project id and project secret

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Users

users related endpoints

get all users

update an user

Authorizations:
basic_auth_superuser

Responses

200

Success

403

Forbidden

get /users
https://messages.smarti18n.com/api/2/users

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

create user

create an user

Authorizations:
basic_auth_superuser
Request Body schema: application/json
mail
string
password
string

Responses

200

Success

403

Forbidden

post /users
https://messages.smarti18n.com/api/2/users

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "mail": "string",
  • "password": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "mail": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "company": "string",
  • "role": "string"
}

get user with details

get an user

Authorizations:
basic_auth_userbasic_auth_superuser
path Parameters
mail
required
string

user mail address

Responses

200

Success

403

Forbidden

get /users/{mail}
https://messages.smarti18n.com/api/2/users/{mail}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "mail": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "company": "string",
  • "role": "string"
}

update user

update an user

Authorizations:
basic_auth_userbasic_auth_superuser
path Parameters
mail
required
string

user mail address

Request Body schema: application/json
firstName
string
lastName
string
company
string

Responses

200

Success

put /users/{mail}
https://messages.smarti18n.com/api/2/users/{mail}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "firstName": "string",
  • "lastName": "string",
  • "company": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "mail": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "company": "string",
  • "role": "string"
}

get user for authentication

get an simplified user this resource should be used for authentication

Authorizations:
basic_auth_userbasic_auth_superuser
path Parameters
mail
required
string

user mail address

Responses

200

Success

403

Forbidden

get /simple-users/{mail}
https://messages.smarti18n.com/api/2/simple-users/{mail}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "mail": "string",
  • "role": "string"
}

Projects

projects related endpoints

get all projects

Authorizations:
basic_auth_userbasic_auth_superuser

Responses

200

Success

403

Forbidden

get /projects
https://messages.smarti18n.com/api/2/projects

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

create project

Authorizations:
basic_auth_userbasic_auth_superuser
Request Body schema: application/json
projectId
string
parentProjectId
string

Responses

200

Success

403

Forbidden

post /projects
https://messages.smarti18n.com/api/2/projects

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "projectId": "string",
  • "parentProjectId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "locales":
    [
    ],
  • "secret": "string",
  • "displayName": "string"
}

get project

Authorizations:
basic_auth_userbasic_auth_superuserbasic_auth_project
path Parameters
projectId
required
string

project id

Responses

200

Success

403

Forbidden

get /projects/{projectId}
https://messages.smarti18n.com/api/2/projects/{projectId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "locales":
    [
    ],
  • "secret": "string",
  • "displayName": "string"
}

update project

Authorizations:
basic_auth_userbasic_auth_superuserbasic_auth_project
path Parameters
projectId
required
string

project id

Request Body schema: application/json
name
string
description
string
locales
Array of strings

Responses

200

Success

403

Forbidden

put /projects/{projectId}
https://messages.smarti18n.com/api/2/projects/{projectId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "locales":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "locales":
    [
    ],
  • "secret": "string",
  • "displayName": "string"
}

delete project

Authorizations:
basic_auth_userbasic_auth_superuserbasic_auth_project
path Parameters
projectId
required
string

project id

Responses

200

Success

403

Forbidden

delete /projects/{projectId}
https://messages.smarti18n.com/api/2/projects/{projectId}

Messages

messages related endpoints

get all messages

Authorizations:
basic_auth_userbasic_auth_superuserbasic_auth_project
path Parameters
projectId
required
string

project id

Responses

200

Success

403

Forbidden

get /projects/{projectId}/messages
https://messages.smarti18n.com/api/2/projects/{projectId}/messages

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

create message

Authorizations:
basic_auth_userbasic_auth_superuserbasic_auth_project
path Parameters
projectId
required
string

project id

Request Body schema: application/json
key
string

Responses

200

Success

403

Forbidden

post /projects/{projectId}/messages
https://messages.smarti18n.com/api/2/projects/{projectId}/messages

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "key": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "key": "message.key",
  • "translations":
    {
    }
}

get message

Authorizations:
basic_auth_userbasic_auth_superuserbasic_auth_project
path Parameters
projectId
required
string

project id

messageKey
required
string

message key

Responses

200

Success

403

Forbidden

get /projects/{projectId}/messages/{messageKey}
https://messages.smarti18n.com/api/2/projects/{projectId}/messages/{messageKey}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "key": "message.key",
  • "translations":
    {
    }
}

update message

Authorizations:
basic_auth_userbasic_auth_superuserbasic_auth_project
path Parameters
projectId
required
string

project id

messageKey
required
string

message key

Request Body schema: application/json
translations
object

Responses

200

Success

403

Forbidden

put /projects/{projectId}/messages/{messageKey}
https://messages.smarti18n.com/api/2/projects/{projectId}/messages/{messageKey}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "translations":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "translations":
    {
    }
}

delete message

Authorizations:
basic_auth_userbasic_auth_superuserbasic_auth_project
path Parameters
projectId
required
string

project id

messageKey
required
string

message key

Responses

200

Success

403

Forbidden

delete /projects/{projectId}/messages/{messageKey}
https://messages.smarti18n.com/api/2/projects/{projectId}/messages/{messageKey}

update a single translation

Authorizations:
basic_auth_userbasic_auth_superuserbasic_auth_project
path Parameters
projectId
required
string

project id

messageKey
required
string

message key

locale
required
string

ISO locale

Request Body schema: application/json
translation
string

Responses

200

Success

403

Forbidden

put /projects/{projectId}/messages/{messageKey}/locale/{locale}
https://messages.smarti18n.com/api/2/projects/{projectId}/messages/{messageKey}/locale/{locale}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "translation": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "translation": "string"
}