Simply.com is available in english

Τεκμηρίωση API της Simply.com

Αυτό το έγγραφο περιγράφει το RESTful JSON API της Simply.com.

API τελικό σημείο

Μπορείτε να βρείτε το HTTP endpoint στο https://api.simply.com/2/ - Προσθέστε αυτό ως πρόθεμα στα ερωτήματά σας.

Παράδειγμα: https://api.simply.com/2/my/products/

Πιστοποίηση

Η αυθεντικοποίηση γίνεται με HTTP Basic Authentication.

Όνομα χρήστη είναι ο αριθμός λογαριασμού του Simply.com (Sxxxxxx).

Κωδικός πρόσβασης είναι το κλειδί API για το συγκεκριμένο λογαριασμό.

Τόσο ο Αριθμός λογαριασμού όσο και το κλειδί API που έχουν εκχωρηθεί στον λογαριασμό σου στο Simply.com μπορούν να βρεθούν στον Πίνακα ελέγχου του Simply.com.

OpenApi Spec / Τεκμηρίωση

Μπορείτε να βρείτε την προδιαγραφή OpenAPI για το API εδώ: https://api.simply.com/2/openapi.json .

Σκεφτείτε να χρησιμοποιήσετε το Swagger UI browser εδώ: https://generator.swagger.io/ .

Όρια ρυθμού

Το API υπόκειται σε περιορισμούς ταχύτητας, μόνο για την πρόληψη κατάχρησης.

Μπορείτε να δείτε το όριο και τη χρήση στο X-RateLimit-Limit και X-RateLimit-Remaining κεφαλίδες.

Υλοποιήσεις βιβλιοθηκών

Οι παρακάτω βιβλιοθήκες είναι διαθέσιμες για χρήση.

Υλοποιήσεις ACME

acme.sh https://github.com/acmesh-official/acme.sh/
Posh-ACME https://github.com/rmbolger/Posh-ACME/
cert-manager service https://github.com/RunnerM/simply-dns-webhook/
Certbot plugin https://github.com/JohNan/certbot-dns-simply/
Webhook provider for ExternalDNS https://github.com/uozalp/external-dns-simply-webhook

API υλοποιήσεις

PHP https://github.com/simplycom/api-php/

Παραδείγματα

Το Dynamic DNS βοηθά

Τα σημεία άκρων /ddns/ και /dyndns/ Σας βοηθά εύκολα να ρυθμίσετε το DDNS σε ένα domain.

/dyndns/ προσομοιώνει αυστηρά το πρωτόκολλο DynDns, ενώ /ddns/ προσπαθεί να δώσει πιο περιγραφικές απαντήσεις και αποδέχεται περισσότερα επιχειρήματα.

Παράδειγμα cURL (Προτεινόμενο)

Χρησιμοποιήστε την παρακάτω εντολή Curl για να ορίσετε home.example.com στην εξωτερική IP για τον αιτούντα πελάτη:

curl -s -u "ACCOUNTNAME:APIKEY" "https://api.simply.com/2/ddns/?domain=example.com&hostname=home.example.com"

Μπορείτε να ρυθμίσετε αυτήν την εντολή να τρέχει σε ένα crontab, σε ένα τοπικό μηχάνημα, κάθε 15 λεπτά ή περίπου.

Synology

Στο Synology μπορείτε να χρησιμοποιήσετε την παρακάτω σύνταξη ως προσαρμοσμένο πάροχο DDNS

https://api.simply.com/2/dyndns/?hostname=__HOSTNAME__&myip=__MYIP__

hostname θα πρέπει στη συνέχεια να δοθεί ως το πλήρες προσδιορισμένο όνομα τομέα, το οποίο θέλετε να ενημερώσετε, π.χ. home.example.com.

Home Assistant

# In configuration.yaml file
rest_command:
  simplycom_ddns:
    username: "ACCOUNTNAME"
    password: "APIKEY"
url: "https://api.simply.com/2/ddns/?domain=example.com&hostname=home.example.com"
# Automation
alias: Simply.com DDNS
trigger:
- platform: time_pattern
  minutes: "0"
  seconds: "0"
action:
- service: rest_command.simplycom_ddns

Unifi

Στο UniFi OS πρέπει να ρυθμίσετε έναν προσαρμοσμένο πάροχο Dynamic DNS και να εισαγάγετε την ακόλουθη συμβολοσειρά στο πεδίο "Server".

api.simply.com/2/dyndns/?hostname=%h&myip=%i