Перейти до вмісту

Клієнтські бібліотеки

Офіційний клієнт — onetime-ruby, який підтримує API v1 і v2, усі регіональні домени та користувацькі базові URL-адреси.

Усе інше на цій сторінці підтримується спільнотою. Більшість цих бібліотек з’явилися до API v2 і регіональних доменів, тому зазвичай вони звертаються до застарілих кінцевих точок v1 на onetimesecret.com — перевірте примітку про стан у кожному записі та переконайтеся, що бібліотека працює з вашим регіоном або самостійно розгорнутим екземпляром, перш ніж на неї покладатися.

Мова Бібліотека Остання активність¹ Регіональний / користувацький домен
Ruby onetime-ruby (офіційна) 2026-06 ✅ усі регіони + користувацька базова URL-адреса
Go go-onetimesecret 2026-05 хост США
Python onetimesecret-cli 2024-11 параметр регіону США / ЄС
Go otsgo 2024-03 не задокументовано
PowerShell OneTimeSecret 2021-06 користувацька базова URL-адреса
Bash onetimesecret-bash 2020-05 користувацький хост
Python py_onetimesecret 2019-05 ❌ (епоха Python 2)
C# OneTimeSharp 2018-05 ❌
Java onetime-java 2014-06 лише URL-адреса самостійно розгорнутого екземпляра
Perl Net::OneTimeSecret 2012-02 ❌

¹ Останній коміт або реліз на момент останнього аудиту (2026-07).

Сторінка GitHub - onetime-ruby, автор Delano — офіційний клієнт, активно підтримується (останній коміт 2026-06). Підтримує API v1 (застарілий) і v2, регіональні домени та користувацькі базові URL-адреси. Потребує Ruby 3.1+, без залежностей під час виконання.

require 'onetime/api'
api = Onetime::API.new('YOUR_EMAIL', 'YOUR_OTS_APIKEY')
options = {
secret: 'Jazz, jazz and more jazz.',
recipient: 'example@onetimesecret.com',
ttl: 7200
}
ret = api.post('/share', options)
puts ret['secret_key']

Сторінка GitHub - onetimesecret-cli, автор slashpass — підтримується спільнотою (останній коміт 2024-11). Підтримує параметр регіону (us / eu).

from onetimesecret import OneTimeSecretCli
cli = OneTimeSecretCli(ONETIMESECRET_USER, ONETIMESECRET_KEY)
cli.create_link("secret") # return a link like https://onetimesecret.com/secret/xxxxxxxxxxx

Сторінка GitHub - py_onetimesecret, автор Vladislav Stepanov — не підтримується (останній коміт 2019; приклад нижче написано для Python 2). Використовує застарілий API v1 лише на onetimesecret.com.

from onetimesecret import OneTimeSecret
o = OneTimeSecret("YOUR_EMAIL", "YOUR_OTS_APIKEY")
secret = o.share(u"test")
print o.retrieve_secret(secret["secret_key"])
# {u'secret_key': u'dtr7ixukiolpx1i4i87kahmhyoy2q65',
# u'value': u'test'}

Net::OneTimeSecret на CPAN, автор Kyle Dawkins — не підтримується (останній реліз 0.04, 2012-02). З’явилася до API v2 і регіональних доменів.

#!/usr/bin/env perl
use Net::OneTimeSecret;
# Note: replace these with yours in order for this to work!
my $customerId = 'YOUR_EMAIL';
my $testApiKey = 'YOUR_OTS_APIKEY';
my $api = Net::OneTimeSecret->new( $customerId, $testApiKey );
my $result = $api->shareSecret( 'Jazz, jazz and more jazz.',
passphrase => 'thepassword',
recipient => 'kyle@shoffle.com',
ttl => 7200,
);
printf( "%s\n", $result->{secret_key} );
my $secret = $api->retrieveSecret( $result->{secret_key}, passphrase => "thepassword" );
printf( "%s\n", $secret->{value} );

Сторінка GitHub - onetime-java, автор Marcin Pawlowski — не підтримується (останній коміт 2014-06). Приймає URL-адресу екземпляра, тому може працювати із самостійно розгорнутим екземпляром, але з’явилася до API v2.

OneTimeSecret ots = new OneTimeSecretRestImpl(
"https://path/to/ots/instance",
"ots-username",
"ots-apikey");
GenerateResponse generateResponse = ots.generate(
new GenerateRequest.Builder()
.withPassphrase("supersecret")
.build());
RetrieveResponse retrieveResponse = ots.retrieve(
new RetrieveRequest.Builder()
.withSecretKey(generateResponse.getSecretKey())
.withPassphrase("supersecret")
.build());
assertEquals(generateResponse.getValue(), retrieveResponse.getValue());

Сторінка GitHub - OneTimeSharp, автор Vladislav Stepanov — не підтримується (останній коміт 2018-05). Використовує застарілий API v1 лише на onetimesecret.com.

// You can use OneTimeSharp in any of your projects which are compatible with .NET (4.0+) or Mono (2.10.8+).
using VStepanov.OneTimeSharp;
class Test
{
static void Main(string[] args)
{
var ots = new OneTimeSecret("YOUR_EMAIL", "YOUR_OTS_APIKEY");
var generated = ots.GenerateSecret();
Console.WriteLine(generated.Value); // LR*?us*A(UT*
Console.WriteLine(generated.SecretKey); // ikzx3m77j5by8411cg5lk5fvfylvl0i
Console.WriteLine(ots.GetSecretLink(generated)); // https://onetimesecret.com/secret/ikzx3m77j5by8411cg5lk5fvfylvl0i
var shared = ots.ShareSecret("Hello, OTS!");
Console.WriteLine(shared.MetadataKey); // kd6rgsucl98qbgu9eavjq4k5sdxsom0
Console.WriteLine(ots.GetMetadataLink(shared)); // https://onetimesecret.com/private/kd6rgsucl98qbgu9eavjq4k5sdxsom0
}
}

Сторінка GitHub - go-onetimesecret, автор Corbalt — підтримується спільнотою (останній коміт 2026-05, оновлено для хоста us.onetimesecret.com). Містить CLI.

import ots "github.com/corbaltcode/go-onetimesecret"
client := ots.Client{
Username: "user@example.com",
Key: "my api key",
}
metadata, err := client.Put("the launch codes", "passphrase", 0, "")
if err != nil {
// handle error
}
secret, err := client.Get(metadata.SecretKey, "passphrase")
if err != nil {
// handle error
}
// prints "the launch codes"
print(secret)
Термінал
$ go install github.com/corbaltcode/go-onetimesecret/cmd/ots@latest
$ ots put 'what is essential is invisible to the eye'
hdjk6p0ozf61o7n6pbaxy4in8zuq7sm ifipvdpeo8oy6r8ryjbu8y7rhm9kty9
$ ots get hdjk6p0ozf61o7n6pbaxy4in8zuq7sm
what is essential is invisible to the eye
$ ots gen
rVjbS$twCJkS 4nwhy7v4fnabayqc5auv4ogh0nfr20 flsdlaun6hwczqu9utmc0vts5xj9xu1
$ ots burn flsdlaun6hwczqu9utmc0vts5xj9xu1
flsdlaun6hwczqu9utmc0vts5xj9xu1

Сторінка GitHub - otsgo, автор Emídio Neto — підтримується спільнотою (останній реліз v1.1.0, 2024-03). Підтримку регіональних доменів не задокументовано.

// Build a new client
client := ots.NewClient(
WithUsername("otsuser@domain.com"),
WithApiKey("xxxxxxxx"),
)
// Send a request with context
ctx := context.Background()
response, err := client.GetStatus(ctx)
if err != nil {
panic(err)
}
fmt.Println(response.Status)

Сторінка GitHub - OneTimeSecret, автор Craig Gumbley — не підтримується (останній реліз 2021-06). Підтримує користувацький -BaseUrl, тому може вказувати на регіон або самостійно розгорнутий екземпляр, але з’явилася до API v2.

Термінал
# Install from the PowerShell gallery
Install-Module -Name OneTimeSecret -Scope CurrentUser
# Set connection information
Set-OTSAuthorizationToken -Username user@mail.com -APIKey xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# Generate a new shared secret
New-OTSSharedSecret -Secret "Very Secret" -Passphrase 1234 -Recipient user@mail.com
# Retrieve a secret
Get-OTSSecret -SecretKey qqevnp70b4uoiax4knzhwlhros6ne7x -Passphrase 1234
# View all functions that are available
Get-Command -Module OneTimeSecret | Select Name

Сторінка GitHub - onetimesecret-bash, автор Eric Engstrom — не підтримується (останній коміт 2020-05). Підтримує користувацький хост через ots_set_host, але з’явилася до API v2 і регіональних доменів.

Приклад використання як API для сценаріїв

Розділ під назвою «Приклад використання як API для сценаріїв»
Термінал
# source for use anonymously (secrets created anonymously)
source ots.bash
# or, source with specific auth credentials
APIUSER="USERNAME"
APIKEY="APIKEY"
source ots.bash -u $APIUSER -k $APIKEY
# check status of server
ots_status
# create a secret and get back the URL
URL=$(echo "secret" | ots_share)
# share a multi line secret via HEREDOC.
URL=$(ots_share <<-EOF
This is a Secret
... on multiple lines
EOF
)
# pass options to share or generate.
URL=$(ots_share ttl=600 \
passphrase="shared-secret" \
recipient="someone@somewhere.com" <<< "SECRET")
# fetch the secret data
local DATA="$(ots_retrieve "$URL")"
# share/generate a new secret, and get back the private metadata key
local KEY=$(ots_metashare <<< "SECRET")
local KEY=$(ots_metagenerate)
# get a list of private metadata keys recently created.
# note that this requires valid authentication credentials
local -a RECENT=( $(ots_recent) )
# check on the current state of a secret, given the private key
ots_state $KEY
# burn a secret, given the private key
ots_burn $KEY
Термінал
# Share a secret (from stdin)
./ots share
SECRET
^D
# Share a secret (via HEREDOC)
./ots share <<-EOF
This is a multi-line secret via HEREDOC.
Something else goes here.
EOF
# Get/Retrieve a secret:
./ots get <key|url>
./ots retrieve <key|url>
# Burn a secret, given its private metadata key:
./ots burn <key>