Base Client¶
BaseAPIClient is the shared foundation for every SDK client. BrowsingAPI, UserManagementAPI, OrgManagementAPI, FileAPI, LogExtractionAPI, and HarvesterAPI all subclass it, so the members documented here are available on each of them in addition to their own methods.
You rarely instantiate BaseAPIClient directly. Its members matter for three things: the configuration keys every client reads, batching several wire commands into one request, and building the TLS context used by the SDK's async paths.
See Configuration for the full settings list, Authentication for token setup, Async Support for the async methods that consume the SSL context, and Wire Protocol for the command-array format batch_request() accepts.
Base API client for Authentic8 Silo platform APIs.
Every SDK client — BrowsingAPI, UserManagementAPI,
OrgManagementAPI, FileAPI, LogExtractionAPI and
HarvesterAPI — subclasses this class, so the members documented here
are available on all of them. It provides:
- HTTP session management with retry logic for idempotent methods
- Authentication handling (the
setauthcommand is injected for you) - Request and response logging, with credential-bearing values redacted
- Error handling and exception mapping onto the
SiloErrorhierarchy - Rate limit handling, including
Retry-After
You normally instantiate a subclass rather than this class directly. Use it as a context manager so the underlying HTTP session is always closed.
Attributes:
| Name | Type | Description |
|---|---|---|
config |
Configuration dictionary the client was built from. |
|
session |
|
|
base_url |
Base URL for API endpoints ( |
|
timeout |
Request timeout in seconds ( |
|
max_retries |
Maximum retry attempts for idempotent requests
( |
|
retry_delay |
The configured |
|
logger |
The shared |
Examples:
>>> from silo_sdk import UserManagementAPI, load_config
>>> config = load_config()
>>> with UserManagementAPI(config) as api:
... users = api.list_users(org=config["TOP_ORG"])
Source code in silo_sdk/base/api_client.py
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 | |
__init__ ¶
Initialize the base API client.
Reads the following keys from config; every one of them is
optional and falls back to the default shown:
| Key | Default | Purpose |
|---|---|---|
API_URL |
https://extapi.authentic8.com |
Base URL for all requests |
REQUEST_TIMEOUT |
30 |
Per-request timeout in seconds |
MAX_RETRIES |
3 |
Retry attempts for idempotent methods |
RETRY_DELAY |
5 |
Stored on the client; not read by the SDK |
LOG_LEVEL |
INFO |
Level for the shared silo_sdk logger |
USER_AGENT |
SDK default | User-Agent header sent on every request |
PROXY |
unset | Proxy mapping passed through to requests |
ENABLE_REQUEST_LOGGING |
False |
Log each request's commands, redacted |
Subclasses add their own required keys — most importantly the API
token for the surface they talk to. See the Configuration guide for
the full list and the matching A8_* environment variables.
API_URL must use https. Every request carries an API token in
its payload, so a plaintext URL would disclose that token; plain
http is accepted only against loopback for local testing, and a
URL with embedded user:password@ credentials is always rejected.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
config
|
dict[str, Any]
|
Configuration dictionary containing API settings. |
required |
Raises:
| Type | Description |
|---|---|
ConfigurationError
|
If |
Source code in silo_sdk/base/api_client.py
batch_request ¶
Execute multiple wire-format commands in a single batch POST.
Sends every command to the Authentic8 API in a single HTTP round trip
instead of one request per command. The setauth command is
injected automatically — do not include it.
Unlike the single-command methods on the API subclasses, per-item
errors in the response are not raised as exceptions. Each result
dict may contain either a "result" key (success) or an
"error" key (failure for that one command), and the caller is
responsible for inspecting individual results. Only failures of the
HTTP request as a whole raise.
The response is positional: results come back in the order the commands were submitted. A short list means the server did not return a result for every command — treat a missing entry as "no response received" rather than as success.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
commands
|
list[dict[str, Any]]
|
Non-empty list of command dicts. Each must have a
|
required |
auth_token
|
str
|
Authentication token to use for the batch. |
required |
Returns:
| Type | Description |
|---|---|
list[dict[str, Any]]
|
List of result dicts, one per submitted command (the |
Raises:
| Type | Description |
|---|---|
ValidationError
|
If |
SiloError
|
If the HTTP request itself fails (timeout, connection error, non-200 status code). |
Examples:
>>> client = BaseAPIClient(config)
>>> results = client.batch_request(
... [
... {"command": "listusers", "org": "MyOrg"},
... {"command": "deleteuser", "username": "u@co.com"},
... ],
... auth_token=config["SYNC_TOKEN"],
... )
>>> for r in results:
... print(r.get("result") or r.get("error"))
Source code in silo_sdk/base/api_client.py
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 | |
create_ssl_context
staticmethod
¶
Create an SSL context backed by the certifi certificate bundle.
Returns a context with full certificate validation enabled, using the
curated CA bundle shipped by the certifi package rather than the
host's trust store. The SDK's own async methods use this, and it is
exposed so that code building its own httpx client against the
Silo API verifies certificates the same way.
The SDK's asynchronous methods are built on httpx; pass the
context as verify= when constructing the client. Never substitute
verify=False — that disables certificate validation entirely and
exposes the API token carried in every request payload.
Build it once and reuse it. Each call reads and parses the certifi CA
bundle from disk, which is comparatively expensive, so calling this
per request adds file I/O and certificate parsing to every call. The
SDK's own async clients build the context once in __init__ and
hold on to it for the lifetime of the instance; do the same in your
own code, and keep it out of request paths and loops.
The returned context is not modified by the SDK. Callers that need a
private or corporate CA can load additional certificates onto it with
the standard ssl.SSLContext methods before use.
Returns:
| Type | Description |
|---|---|
SSLContext
|
An |
Examples:
Build the context once, then reuse it for every request made through the client:
>>> import httpx
>>> from silo_sdk import BaseAPIClient
>>> ssl_context = BaseAPIClient.create_ssl_context()
>>> async with httpx.AsyncClient(verify=ssl_context) as client:
... response = await client.get(url)
Holding it on an instance, the way the SDK's own async clients do, keeps the bundle parse out of the request path:
>>> class MyAsyncClient:
... def __init__(self) -> None:
... self._ssl_context = BaseAPIClient.create_ssl_context()
...
... async def fetch(self, url: str) -> httpx.Response:
... async with httpx.AsyncClient(
... verify=self._ssl_context
... ) as client:
... return await client.get(url)
Source code in silo_sdk/base/api_client.py
close ¶
Close the underlying HTTP session and release its connections.
Call this when you are finished with a client that was not created as a context manager. It is safe to call more than once, and safe to call on a client whose session was never opened.
Prefer the context manager form, which closes the session for you even when the block raises.
Examples:
>>> api = UserManagementAPI(config)
>>> try:
... users = api.list_users(org="MyOrg")
... finally:
... api.close()
Equivalent, and preferred:
Source code in silo_sdk/base/api_client.py
__enter__ ¶
Enter the context manager and return the client itself.
Returns:
| Type | Description |
|---|---|
BaseAPIClient
|
This client, so it can be bound with |
__exit__ ¶
Exit the context manager, closing the HTTP session.
The session is closed whether the block completed normally or raised.
Exceptions are not suppressed — any exception raised inside the
with block propagates to the caller.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
exc_type
|
Any
|
Exception class raised in the block, or None. |
required |
exc_val
|
Any
|
Exception instance raised in the block, or None. |
required |
exc_tb
|
Any
|
Traceback for the exception, or None. |
required |