Fontes

Obter todas as origens

/api/v1/sources

Permissões necessárias: exibir origens

• Bash

  curl -X GET 'https://<my_api_endpoint>/api/v1/sources' \
      -H "Authorization: Bearer $REINFER_TOKEN"

• Nó

  const request = require("request");
  
  request.get(
    {
      url: "https://<my_api_endpoint>/api/v1/sources",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.get(
      "https://<my_api_endpoint>/api/v1/sources",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• Resposta

  {
    "sources": [
      {
        "created_at": "2016-02-10T23:13:28.340295+00:00",
        "description": "An optional long form description.",
        "id": "18ba5ce699f8da1f",
        "last_modified": "2016-02-10T23:13:28.340295+00:00",
        "name": "example",
        "owner": "<project>",
        "sensitive_properties": [],
        "should_translate": false,
        "title": "An Example Source",
        "updated_at": "2016-02-10T23:13:28.340295+00:00"
      }
    ],
    "status": "ok"
  }

Obter origens por projeto

/api/v1/sources/<project>

Permissões necessárias: exibir origens

• Bash

  curl -X GET 'https://<my_api_endpoint>/api/v1/sources/<project>' \
      -H "Authorization: Bearer $REINFER_TOKEN"

• Nó

  const request = require("request");
  
  request.get(
    {
      url: "https://<my_api_endpoint>/api/v1/sources/<project>",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.get(
      "https://<my_api_endpoint>/api/v1/sources/<project>",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• Resposta

  {
    "sources": [
      {
        "created_at": "2016-02-10T23:13:28.340295+00:00",
        "description": "An optional long form description.",
        "id": "18ba5ce699f8da1f",
        "last_modified": "2016-02-10T23:13:28.340295+00:00",
        "name": "example",
        "owner": "<project>",
        "sensitive_properties": [],
        "should_translate": false,
        "title": "An Example Source",
        "updated_at": "2016-02-10T23:13:28.340295+00:00"
      }
    ],
    "status": "ok"
  }

Obter origem por projeto e nome

/api/v1/sources/<project>/<source_name>

Permissões necessárias: exibir origens

• Bash

  curl -X GET 'https://<my_api_endpoint>/api/v1/sources/<project>/example' \
      -H "Authorization: Bearer $REINFER_TOKEN"

• Nó

  const request = require("request");
  
  request.get(
    {
      url: "https://<my_api_endpoint>/api/v1/sources/<project>/example",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.get(
      "https://<my_api_endpoint>/api/v1/sources/<project>/example",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• Resposta

  {
    "source": {
      "created_at": "2016-02-10T23:13:28.340295+00:00",
      "description": "An optional long form description.",
      "id": "18ba5ce699f8da1f",
      "last_modified": "2016-02-10T23:13:28.340295+00:00",
      "name": "example",
      "owner": "<project>",
      "sensitive_properties": [],
      "should_translate": false,
      "title": "An Example Source",
      "updated_at": "2016-02-10T23:13:28.340295+00:00"
    },
    "status": "ok"
  }

Obter uma origem por id

/api/v1/sources/id:<source_id>

Permissões necessárias: exibir origens

• Bash

  curl -X GET 'https://<my_api_endpoint>/api/v1/sources/id:18ba5ce699f8da1f' \
      -H "Authorization: Bearer $REINFER_TOKEN"

• Nó

  const request = require("request");
  
  request.get(
    {
      url: "https://<my_api_endpoint>/api/v1/sources/id:18ba5ce699f8da1f",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.get(
      "https://<my_api_endpoint>/api/v1/sources/id:18ba5ce699f8da1f",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• Resposta

  {
    "source": {
      "created_at": "2016-02-10T23:13:28.340295+00:00",
      "description": "An optional long form description.",
      "id": "18ba5ce699f8da1f",
      "language": "en",
      "last_modified": "2016-02-10T23:13:28.340295+00:00",
      "name": "example",
      "owner": "<project>",
      "sensitive_properties": [],
      "should_translate": false,
      "title": "An Example Source",
      "updated_at": "2016-02-10T23:13:28.340295+00:00"
    },
    "status": "ok"
  }

Criar uma origem

/api/v1/sources/<project>/<source_name>

Permissões necessárias: administrador de fontes

• Bash

  curl -X PUT 'https://<my_api_endpoint>/api/v1/sources/<project>/example' \
      -H "Authorization: Bearer $REINFER_TOKEN" \
      -H "Content-Type: application/json" \
      -d '{
    "source": {
      "description": "An optional long form description.",
      "title": "An Example Source"
    }
  }'

• Nó

  const request = require("request");
  
  request.put(
    {
      url: "https://<my_api_endpoint>/api/v1/sources/<project>/example",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
      json: true,
      body: {
        source: {
          description: "An optional long form description.",
          title: "An Example Source",
        },
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.put(
      "https://<my_api_endpoint>/api/v1/sources/<project>/example",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
      json={
          "source": {
              "title": "An Example Source",
              "description": "An optional long form description.",
          }
      },
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• Resposta

  {
    "source": {
      "created_at": "2016-02-10T23:13:28.340295+00:00",
      "description": "An optional long form description.",
      "id": "18ba5ce699f8da1f",
      "language": "en",
      "last_modified": "2016-02-10T23:13:28.340295+00:00",
      "name": "example",
      "owner": "<project>",
      "sensitive_properties": [],
      "should_translate": false,
      "title": "An Example Source",
      "updated_at": "2016-02-10T23:13:28.340295+00:00"
    },
    "status": "ok"
  }

Nome	Tipo	Required	Descrição
language	String	não	O idioma principal da origem. Os valores aceitos são en (inglês) e Multilingual. O padrão é en.
title	String	não	Título legível por humanos de uma linha para a origem.
description	String	não	Uma descrição mais longa da origem.
should_translate	Booleano	não	Se as mensagens carregadas para esta origem devem ser traduzidas para o language quando necessário. O padrão é false.
sensitive_properties	array<string>	não	Uma matriz de propriedades que deve ser marcada como confidencial e ocultada para usuários sem privilégios.
bucket_id	String	não	ID de um bucket do qual carregar dados. Os dados serão analisados em comentários e carregados para esta origem.

Atualizar uma origem

/api/v1/sources/<project>/<source_name>

Permissões necessárias: administrador de fontes

• Bash

  curl -X POST 'https://<my_api_endpoint>/api/v1/sources/<project>/example' \
      -H "Authorization: Bearer $REINFER_TOKEN" \
      -H "Content-Type: application/json" \
      -d '{
    "source": {
      "description": "An alternative description."
    }
  }'

• Nó

  const request = require("request");
  
  request.post(
    {
      url: "https://<my_api_endpoint>/api/v1/sources/<project>/example",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
      json: true,
      body: { source: { description: "An alternative description." } },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.post(
      "https://<my_api_endpoint>/api/v1/sources/<project>/example",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
      json={"source": {"description": "An alternative description."}},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• Resposta

  {
    "source": {
      "created_at": "2016-02-10T23:13:28.340295+00:00",
      "description": "An alternative description.",
      "id": "18ba5ce699f8da1f",
      "language": "en",
      "last_modified": "2016-02-11T08:06:14.944290+00:00",
      "name": "example",
      "owner": "<project>",
      "sensitive_properties": [],
      "should_translate": false,
      "title": "An Example Source",
      "updated_at": "2016-02-11T08:06:14.944290+00:00"
    },
    "status": "ok"
  }

Nome	Tipo	Required	Descrição
title	String	não	Título legível por humanos de uma linha para a origem.
description	String	não	Uma descrição mais longa da origem.
should_translate	Booleano	não	Se as mensagens carregadas para esta origem devem ser traduzidas para inglês quando necessário. O padrão é false.
sensitive_properties	array<string>	não	Uma matriz de propriedades que deve ser marcada como confidencial e ocultada para usuários sem privilégios.
bucket_id	String	não	ID de um bucket do qual carregar dados. Os dados serão analisados em comentários e carregados para esta origem.

Excluir uma origem

/api/v1/sources/id:<source_id>

Permissões necessárias: administrador de fontes

• Bash

  curl -X DELETE 'https://<my_api_endpoint>/api/v1/sources/id:18ba5ce699f8da1f' \
      -H "Authorization: Bearer $REINFER_TOKEN"

• Nó

  const request = require("request");
  
  request.delete(
    {
      url: "https://<my_api_endpoint>/api/v1/sources/id:18ba5ce699f8da1f",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.delete(
      "https://<my_api_endpoint>/api/v1/sources/id:18ba5ce699f8da1f",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• Resposta

  {
    "status": "ok"
  }