Skip to content

README.md

Latest commit

 

History

History
43 lines (26 loc) · 1.67 KB

README.md

File metadata and controls

43 lines (26 loc) · 1.67 KB
Raw

ArchFX Toolkit

This repo has two independent parts. Use whichever fits what you're doing — they don't depend on each other.

  1. 🐍 API Scripts (Python) — authenticate and call the ArchFX Platform APIs.
  2. 🎨 Design Kit (no Python needed) — a design system for building ArchFX custom apps, prototypes and mockups.

🐍 API Scripts (Python)

Sample scripts leveraging the ArchFX Platform APIs.

📚 API Reference (Swagger UI)

https://{{tenant_name}}.archfx.io/api/docs/#/

Don't know your tenant name? Reach out to support because you're going to need that for everything. Similiarly, you must have username and password access to Arch. SSO won't work here.

🚀 Getting Started

The best way to get started is to run the authenticate.py script.

python3 authenticate.py

If this runs successfully: You're authenticated!
✅ You have valid credentials
✅ You can now make all kinds of API requests using the access_token.

🎨 Design Kit (no Python needed)

A design system for building ArchFX custom apps, prototypes and mockups — plain HTML/CSS with no build step, meant to be handed to an AI coding tool (Claude Code, Copilot, etc.) or used by hand.

It lives in the archfx_customapp_design_kit/ subfolder of this repo.

How to get it

  1. Download or clone this entire repo.
  2. Open to archfx_customapp_design_kit folder.
  3. Read the README.md file. It contains instructions on how to get started using the design kit to build your own custom apps. archfx_customapp_design_kit/README.md